Skip to main content

1. Create an Account

Sign up at closient.com/accounts/signup to create your free account. You’ll land in your Dashboard where you can create an organization and generate API keys.

2. Generate an API Key

Navigate to Settings > API Keys in your Dashboard and create a new key. Keys follow the format:
<prefix>_<body>_<checksum>
PrefixTypeUse Case
csbBusinessServer-side API access (full permissions)
csuUserUser-scoped API access
cpkPublishableClient-side embeds and widgets (rate-limited, org-scoped)
The body is 32 random characters and the checksum is a CRC-32 hex digest for format validation.
API keys are shown once at creation time. They’re stored as SHA-256 hashes and cannot be retrieved — only revoked and replaced.

3. Look Up a Product by GTIN

curl -H "X-API-Key: YOUR_API_KEY" \
  https://www.closient.com/products/api/v1/products?gtin=00012345678905
GTINs are always normalized to GTIN-14 (zero-padded). You can pass GTIN-8, GTIN-12 (UPC-A), GTIN-13 (EAN), or GTIN-14 — the API handles normalization. Any GTIN can be resolved via a GS1 Digital Link URI:
curl -H "Accept: application/json" \
  https://www.closient.com/01/00012345678905

5. Understand the Response Envelope

All list endpoints return paginated results:
{
  "data": [
    {
      "id": "ack3p9tw6x7r",
      "gtin": "00012345678905",
      "product_name": "Example Product",
      "brand": "Example Brand",
      "data_source": "claimed",
      "confidence_score": 0.95
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 25,
    "total_count": 1,
    "total_pages": 1,
    "has_next": false,
    "has_previous": false
  }
}

Next Steps

Authentication

API key types, RBAC roles, and security best practices.

Digital Link Resolution

Configure resolution rules, scope hierarchy, and time-based routing.

EPCIS 2.0

Capture supply chain events with full vocabulary support.

API Reference

Browse all 18 APIs with interactive playgrounds.