API Documentation

Authentication

All API requests require authentication using an API key. Generate API keys from your dashboard after adding a custom app.

Rate Limits

API requests are rate limited to ensure fair usage and protect against abuse.

When rate limited, requests will return HTTP 429. Wait before retrying.

GraphQL Proxy

Execute GraphQL queries against the Shopify Admin API. AuthCrate handles token management automatically.

Request Body

{
  "query": "{ shop { name email } }",
  "variables": {}
}

Example Request

curl -X POST https://authcrate.shop/api/v1/graphql \
  -H "X-Api-Key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "{ shop { name email myshopifyDomain } }"
  }'

Example Response

{
  "data": {
    "shop": {
      "name": "My Store",
      "email": "[email protected]",
      "myshopifyDomain": "my-store.myshopify.com"
    }
  }
}

REST Proxy

Execute REST API requests against the Shopify Admin API. Supports GET, POST, PUT, and DELETE methods.

Supported Methods

Common Endpoints

Example: Get Shop Info

curl https://authcrate.shop/api/v1/rest/shop.json \
  -H "X-Api-Key: your_api_key"

Example: List Products with Query Parameters

curl "https://authcrate.shop/api/v1/rest/products.json?limit=10&status=active" \
  -H "X-Api-Key: your_api_key"

Example: Create a Product

curl -X POST https://authcrate.shop/api/v1/rest/products.json \
  -H "X-Api-Key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "product": {
      "title": "New Product",
      "body_html": "
Product description
",
      "vendor": "My Store"
    }
  }'

Example: Update a Product

curl -X PUT https://authcrate.shop/api/v1/rest/products/123456789.json \
  -H "X-Api-Key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "product": {
      "title": "Updated Product Title"
    }
  }'

Example: Delete a Product

curl -X DELETE https://authcrate.shop/api/v1/rest/products/123456789.json \
  -H "X-Api-Key: your_api_key"

Error Handling

When an error occurs, the API returns a JSON response with an errors array.

Error Response Format

{
  "errors": [
    {
      "message": "Error description here"
    }
  ]
}

HTTP Status Codes

Code Examples

Here are examples in popular programming languages to help you get started.

const apiKey = 'your_api_key';

// GraphQL request
const graphqlResponse = await fetch('https://authcrate.shop/api/v1/graphql', {
  method: 'POST',
  headers: {
    'X-Api-Key': apiKey,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    query: '{ shop { name } }',
  }),
});

// REST request
const restResponse = await fetch('https://authcrate.shop/api/v1/rest/products.json?limit=10', {
  headers: {
    'X-Api-Key': apiKey,
  },
});

const products = await restResponse.json();

<?php

$apiKey = 'your_api_key';

// GraphQL request
$ch = curl_init('https://authcrate.shop/api/v1/graphql');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [
        'X-Api-Key: ' . $apiKey,
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'query' => '{ shop { name } }',
    ]),
]);
$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);

// REST request
$ch = curl_init('https://authcrate.shop/api/v1/rest/products.json?limit=10');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'X-Api-Key: ' . $apiKey,
    ],
]);
$products = json_decode(curl_exec($ch), true);
curl_close($ch);

import requests

api_key = 'your_api_key'
headers = {'X-Api-Key': api_key}

# GraphQL request
graphql_response = requests.post(
    'https://authcrate.shop/api/v1/graphql',
    headers={**headers, 'Content-Type': 'application/json'},
    json={'query': '{ shop { name } }'}
)
shop_data = graphql_response.json()

# REST request
rest_response = requests.get(
    'https://authcrate.shop/api/v1/rest/products.json',
    headers=headers,
    params={'limit': 10}
)
products = rest_response.json()