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 withlive_.
- Send it only in the
X-Api-Keyheader. A key in the query string is rejected with400 invalid_request. - Every route under
/v1/platformneeds 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_connectedorin_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.
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.

