Welcome to PartnerBee

PartnerBee is an affiliate and partner marketing platform. It lets any
business launch its own affiliate program: recruit partners, give each one a
trackable referral link, attribute the sales they drive, and pay the right
commission automatically, including on recurring revenue.

This developer hub is about integration: how you connect PartnerBee to your
product so it can credit the right affiliate for every sale.

Choose how to integrate

There are three ways to send PartnerBee what it needs. Most integrations use one,
some combine them.

1. JavaScript Snippet

A small script on your site captures the affiliate referral (?ref=<slug>) in
the visitor's browser and stores it in a first-party cookie. Best for capturing
the click with zero backend work.

Use it when: you want the simplest client-side tracking and will read the cookie
at checkout. → JavaScript Snippet

2. REST API

A server-to-server API. Your backend authenticates with an organization API key
and reports clicks, conversions, customers, and affiliates. Full control, exact
amounts, idempotent.

Use it when: you run your own checkout or backend and want to report sales
precisely. → REST API overview and
API Reference

3. Integrations

Point a payment provider's webhook at PartnerBee. It verifies the event, reads
the affiliate referral from the metadata, and records the sale. No conversion
code on your side.

Use it when: you already charge through Stripe, Asaas, Abacate Pay, Guru, or
Vindi. → Integrations

Which one should I use?

The most common pattern

Snippet on the landing page, signup on your backend, conversion from your payment
gateway. That combines all three methods, and the
Full integration walkthrough shows it end to end.

The full picture

Under the hood every method feeds the same flow:

1. Affiliate shares a link   ?ref=<slug>
2. Visitor lands             -> click captured (snippet or POST /api/clicks)
3. Visitor signs up          -> customer tracked (POST /api/customers)
4. Visitor pays              -> conversion recorded (REST API or a webhook)

Quick check

Whatever method you pick, start by verifying your organization API key (it starts
with beeaff-):

curl https://api.partnerbee.app/api/me \
  -H "Authorization: beeaff-<your-key>"

{ "success": true, "data": { "organization": { "id": "…", "name": "Acme Inc" } } }

Base URL: https://api.partnerbee.app (the legacy host api.beeaffiliate.app
stays active and behaves identically).