Skip to main content
Every partner API request sends your platform key in the X-Api-Key header. The key identifies your platform. There is no other credential.

Your platform key

Branduo Support issues the key when we set up your platform. Production keys begin with live_.
We show the plaintext key once, when we issue it, and store only a hash. Keep it on your server. Never put it in a browser, a mobile app, logs, or a public repository.
  • Send it only in the X-Api-Key header. A key in the query string is rejected with 400 invalid_request.
  • Every route under /v1/platform needs it. The connect link and the Embed plugin need no key.

What the key can reach

A key reaches only your platform’s data:
  • Get your platform and Sync brands at any time.
  • A merchant’s stage with Get a brand and List brands. Before the merchant approves your platform, you see only not_connected or in_progress, unless you sent that store the connect link.
  • A merchant’s offer, partner offers, and placement only after that merchant approved your platform in the Branduo Shopify app. Otherwise the API returns 403 not_approved.
The merchant is always named by their store domain in the URL. The key never stands for a merchant.

Rotate a key

1

Ask Support for a new key

Contact Support. The new key works alongside the old one.
2

Deploy the new key

Update your server to send the new key in X-Api-Key.
3

Ask Support to revoke the old key

Once the new key is working, we revoke the old one.
If a key leaks, contact Support right away so we can revoke it.

Authentication errors

See Errors.