Base URL
Base URL:https://api.branduo.io/v1
Version: v1
How it fits together
1
A merchant clicks Connect Branduo in your app
The button opens the connect link. Branduo
remembers that you sent the merchant, then sends them to the Branduo app in
Shopify.
2
The merchant approves your platform in Shopify
Inside the Branduo Shopify app, the merchant installs if needed, turns on
usage billing, and selects Approve on Run your offer on {your
platform}. Branduo then sends them back to your return URL.
3
Your server calls the partner API
Confirm the approval with Get a brand, show
partner offers, and turn placement on or
off.
Quick start
1
Get your platform ID and key
Contact Branduo Support. We set up your platform and
issue a platform key. Production keys begin with
live_.2
Check your key
Call Get your platform. It returns your
platform ID and name.
3
Follow the guide
Build the custom integration, or add the
Embed plugin and call the offers route from your
server.
Core concepts
Integration options
Plugin or custom: what each one covers.
Connect link
The URL behind your Connect Branduo button, and the return to your app.
Authentication
Send your platform key in
X-Api-Key.Errors
Error responses and HTTP status codes.
Rate limiting
Per partner key and endpoint group, and how to back off on 429.
Pagination
Page through your brands.

