This file previously documented UKIP's early commerce-oriented API surface with product, SKU, brand, and store-first examples. That material is historical context, not the active platform contract.
The current canonical API reference is ../API.md. UKIP's core API now uses domain-agnostic entity terminology:
| Canonical concept | Meaning |
|---|---|
| Entity | Any ingested record normalized into the UKIP canonical model |
| Primary label | Human-readable name/title of the entity |
| Secondary label | Domain facet such as author, institution, source, classification, or a commerce brand in adapter-specific flows |
| Canonical ID | DOI, ORCID, ROR, local identifier, SKU, or other stable source identifier |
| Source adapter | Optional ingestion bridge for a specific external platform or data source |
Legacy commerce aliases remain supported for backward compatibility where existing datasets or adapter contracts require them, including /brands, brand_year_matrix, top_brands, sku, gtin, barcode, and brand_capitalized. New core specs, UI copy, API examples, and tests should prefer the canonical terms above.
Rather than hand-writing HTTP calls, integrators can use the generated clients in
../sdk/:
- TypeScript —
sdk/typescript/, generated with@hey-api/openapi-ts(full coverage). - Python —
sdk/python/, generated withopenapi-python-client.
Both are produced from the drift-gated sdk/openapi.json and consumed by git
reference or local path (not published to npm/PyPI). Install, quickstart, the API
key scope model, and the stability surface are documented in
sdk/README.md. Regenerate with bash scripts/generate-sdk-clients.sh.