API Documentation

1. Generate an API Key

Log in to your Sustalium dashboard and navigate to Settings → API Keys. Create a new API key with the appropriate permissions.

2. Make Your First Request

All API requests must include your API key in the Authorization header:

curl https://api.sustalium.com/v1/products \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

3. Handle Responses

All successful responses return JSON with a data field:

{
  "data": {
    "id": "prod_abc123",
    "sku": "TEE-001",
    "name": "Organic Cotton T-Shirt",
    "category": "Textiles",
    "createdAt": "2025-12-01T10:00:00Z"
  }
}

API requests are rate limited to 100 requests per minute per tenant. Rate limit headers are included in every response:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 2025-12-01T10:05:00Z

If you exceed the rate limit, you'll receive a 429 Too Many Requests response with a Retry-After header.

All errors return JSON with an error field and appropriate HTTP status code:

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Product not found",
    "details": {
      "productId": "prod_abc123"
    }
  }
}