Skip to content
Documentation menu

API overview

Understand authentication, scopes, idempotency, pagination, and safe integration practices.

Start from the API reference

The public API reference is generated from Itemra's OpenAPI contract. Use it for the current operations, request models, response models, and production server URL. Do not infer fields from the browser application.

Authenticate narrowly

Create a separate API key for each integration and grant only the scopes it needs. Store the key in a secret manager, never in source code or a browser bundle. Rotate it when ownership changes or exposure is suspected.

Make requests safely

Send JSON with the documented content type. Follow cursor or page metadata rather than assuming a complete first response. Use an idempotency key for supported writes and retain the returned resource identifier.

Handle failures

Treat validation and conflict responses as permanent until input changes. Retry transient failures with bounded exponential backoff and jitter. Log the Itemra trace or correlation identifier without logging credentials or sensitive payloads.

Continue

Open the public API reference for the machine-readable contract and endpoint examples. Use webhooks to react to changes instead of continuously polling.