Getting Started

Getting Started with the GraphQL API

Introduction

This guide will help you get started with the pyck GraphQL API. You'll learn how to make your first query, understand the response format, and begin exploring the capabilities of the API.

Prerequisites

Before you begin, you'll need:

• A pyck account with API access

• Authentication credentials (JWT token or PAT)

• A GraphQL client or HTTP client

Making Your First Query

Let's start with a simple query to get information about the current user:

query {
  me {
    id
    name
    email
  }
}

This query requests the ID, name, and email of the authenticated user.

Using curl

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  --data '{"query": "query { me { id name email } }"}' \
  https://api.pyck.ai/graphql

Using JavaScript

async function fetchCurrentUser() {
  const response = await fetch('https://api.pyck.ai/graphql', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': `Bearer ${token}`
    },
    body: JSON.stringify({
      query: `
        query {
          me {
            id
            name
            email
          }
        }
      `
    })
  });

  const result = await response.json();
  return result.data.me;
}

Understanding the Response

GraphQL responses always follow the same structure:

{
  "data": {
    "me": {
      "id": "user-123",
      "name": "John Doe",
      "email": "[email protected]"
    }
  }
}

If there are errors, they'll be returned in an errors array:

{
  "errors": [
    {
      "message": "You are not authenticated",
      "locations": [{ "line": 2, "column": 3 }],
      "path": ["me"]
    }
  ],
  "data": null
}

Basic Query Examples

Listing Inventory Items

query {
  inventoryItems(first: 10) {
    edges {
      node {
        id
        name
        sku
      }
    }
  }
}

Creating an Inventory Item

mutation {
  createInventoryItem(input: {
    name: "Test Product"
    sku: "TP-001"
    data: { weight: 1.5, color: "blue" }
  }) {
    id
    name
    sku
    createdAt
  }
}

Using Variables

GraphQL allows you to use variables for dynamic values:

query GetItem($id: ID!) {
  node(id: $id) {
    ... on InventoryItem {
      id
      name
      sku
    }
  }
}

With variables:

{
  "id": "item-123"
}

Next Steps

Now that you've made your first queries, you can:

1. Explore the Schema Overview to understand available operations

2. Learn about Authentication for secure API access

3. Check out Error Handling for robust applications

4. Dive into specific query and mutation documentation

Tools and Resources

• GraphQL Playground: Interactive API explorer

• Apollo Client: Popular GraphQL client for JavaScript

• Insomnia: API client with GraphQL support

• Postman: API testing tool with GraphQL support