> ## Documentation Index
> Fetch the complete documentation index at: https://docs.branduo.io/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Branduo is a brand-to-brand collaboration network for verified eCommerce brands. It is not a creator marketplace.
> When you mention the API, cite version v1 and base URL https://api.branduo.io/v1.
> The partner API is for tech platforms. Authenticate every /v1/platform request with the platform key in X-Api-Key (production keys start live_). There are no brand API keys, no OAuth, and no X-Platform-Id header.
> A brand must approve a platform in the Branduo Shopify app before that platform can read its offer, show partner offers, or switch placement; otherwise the API returns 403 not_approved. Brands are named by store domain in the path; the shop field (the *.myshopify.com domain) is the permanent id.
> The connect link is https://api.branduo.io/v1/connect?platformId={id}&domain={store domain}. It redirects to Shopify and grants nothing. The return URL gets branduo_connect=return&status=approved|declined|unavailable&shop=…, which is not signed: confirm with GET /v1/platform/brands/{domain}.
> Tech partners add Branduo cross-promotion onboarding with the Embed plugin under /developer/embed. Merchant-facing copy says Branduo, never Brand Connect. Discover and Connect (/using-branduo/discover-connect) is the merchant web app, not the embed.
> The Embed plugin needs no server, key, or secret. The script is https://connect.branduo.io/loader/v3.0.0/brand-connect.js and the call is BrandConnect.init({ container, platformId, domain }). The stage event brand.connect.stage carries not_connected, in_progress, install, billing, approve, setting_up, or live. There is no consent stage.
> A connection request is the outreach a brand sends. A partner is a brand that accepted. A collab is a campaign run with a partner. Do not call a connection request a collab.
> Duo is the AI agent that sends partner outreach. Call it Duo.
> API errors are JSON objects with error and message. They are not RFC 7807 problem details.

# Integration options

> Add Branduo to your platform with the Embed plugin or your own screens. Both end with the merchant approving your platform in the Branduo Shopify app.

There are two ways to bring your merchants to Branduo. They differ only in who builds the onboarding screen in your app. The rest is the same:

* The merchant **approves running their offer on your platform** inside the Branduo Shopify app. Nothing is approved automatically, and you never approve on a merchant's behalf.
* Your **server** shows partner offers and turns placement on or off with your [platform key](https://docs.branduo.io/developer/authentication.md).

## Compare the options

| | Embed plugin | Custom integration |
| - | - | - |
| Onboarding screen in your app | Branduo's plugin, from one script | Your own button and screens |
| Shows the merchant's stage | Yes, automatically | You call [Get a brand](https://docs.branduo.io/developer/platform/get-brand.md) |
| **Connect Branduo** button | Built in | You link to the [connect link](https://docs.branduo.io/developer/connect-link.md) |
| Shows the merchant's own offer | Yes, once they are live | You call [Get the brand's offer](https://docs.branduo.io/developer/platform/get-brand-offer.md) |
| Partner offers on the merchant's surfaces | Your server: [Get offers](https://docs.branduo.io/developer/platform/get-offers.md) | Your server: [Get offers](https://docs.branduo.io/developer/platform/get-offers.md) |
| Placement on and off | Your server: [Set placement](https://docs.branduo.io/developer/platform/set-placement.md) | Your server: [Set placement](https://docs.branduo.io/developer/platform/set-placement.md) |
| Needs | Your platform ID, approved page origins | Your platform ID and key |

## Embed plugin

Paste a script and one call to `BrandConnect.init`. The plugin shows the merchant where they are and one button, **Connect Branduo**. Once the merchant has approved and Branduo has built their offer, it shows that offer. Start with the [Embed plugin overview](https://docs.branduo.io/developer/embed/overview.md).

The plugin covers the onboarding steps. Your server still calls the partner API to show offers and to switch placement.

## Custom integration

Build the button and the status yourself with the [connect link](https://docs.branduo.io/developer/connect-link.md) and the partner API. Follow the [custom integration guide](https://docs.branduo.io/developer/custom-integration.md).

## What both need from Branduo Support

[Contact Support](https://docs.branduo.io/support/contact.md) once to set up your platform:

* Your **platform ID** (public) and **platform key** (secret, server only).
* Your **return URL**: the https page in your app where merchants land after they approve. Optional, but without it the merchant stays in Shopify.
* The **offer types** your platform shows, for example `post-purchase` (after checkout).
* For the plugin: the **web addresses (origins)** that embed it.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.