Skip to main content
Brand keys are created and managed in the dashboard, under Credenciais de API in the account menu. Only admins of the brand can see this page.

​
Create a key

After you confirm, the full key is shown once. Lomadee stores only a hash of it and cannot show it again. If you lose it, rotate the key. A brand can have up to 10 active keys.

​
Scopes

A scope is the vertical of the key followed by the resource: network:orders:read, whitelabel:orders:read. All scopes of a key have the same vertical.
whitelabel:affiliates:read returns personal data: name, e-mail, document, phone, address and the additional fields of your program. Grant it only to integrations that need it.
Scopes cannot be edited after creation. To change them, create a new key and revoke the old one.

​
Rotate a key

Rotate issues a new secret for the same key and keeps its name, vertical and scopes. The old secret stops working within 1 minute. Update your integration with the new value right after rotating.

​
Revoke a key

Revoke disables the key permanently. Requests with a revoked key return 401 within 1 minute. A revoked key cannot be restored.

​
What the dashboard shows

​
Keep keys safe

  • Use keys only on servers. Never ship a key in a browser, a mobile app or a public repository.
  • Use one key per integration, so you can revoke one without stopping the others.
  • Set an expiration and rotate before it ends.
  • If a key leaks, revoke it at once and create a new one.