Skip to main content
All endpoints are authenticated with a per-manufacturer API key passed in the X-API-Key header. Send it on every request:

Obtaining an API key

API keys are issued per manufacturer and managed by an account owner:
  1. Log in to the Emidat Platform
  2. Navigate to Settings → Integrations → API Keys for your manufacturer
  3. Click Create API key, give it a name, and optionally restrict its permissions to specific plants and scopes.
  4. Copy the raw key, which is shown only once and cannot be retrieved again

Scopes

A key carries a set of scopes, chosen when it is issued. Each endpoint requires one; a key without it gets 403. A key can never exceed the permissions of the member who issued it. If that member’s role is reduced or their plant access is withdrawn, the key loses the same ground immediately — the scopes stored on it are capped on every request, not at issuance.

Verify your key

GET /v2/me reports what the key can do right now. It needs no scope, so any valid key can call it:
scopes and plant_ids are the effective set, not what was stored at issuance. An empty plant_ids means the key currently reaches no plants. See Introspect API key.

Authentication errors

Treat the raw key as a secret. Store it in your secrets manager, never in source control or logs. If a key is exposed, revoke it and issue a new one.