API key authentication

4 Min. readContinuously maintained · Beta· Uslimato Docs

The API authenticates by API key. Keys are stored SHA-256 hashed, carry scopes for granular permissions and are shown in clear text only once.

1#Create a key

In the developer portal you create a new API key and assign the required scopes. Copy the key immediately – it's shown only once and afterwards stored only as a SHA-256 hash.

Open the developer portal
Create a new key and choose scopes
Store the key safely (shown only once)

2#Use the key

Pass the key as a bearer token in the Authorization header:

bash

curl -X POST https://api.uslimato.com/v1/assets \
  -H "Authorization: Bearer $USLIMATO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "tag": "AST-000142", "status": "in_stock" }'

3#Scopes

Scopes limit what a key can do – such as read-only or also write on assets. Always grant only the rights an integration actually needs.

Tip

Every key is bound to exactly one tenant – a key can never see another tenant's data.

Done!

Your API key is active – you can now send authenticated requests and track usage in the developer portal.

Was this helpful?

Suggest an edit