Developer API
Create Butler deeplinks from your own platform
If your platform shares customers with Influencer Butler, those creators can let you build their branded Butler links through our API. You authenticate with a key and secret they issue you, and every link you create shows up in their own dashboard.
How access works
The creator is always in control
A creator issues you a key
In the Influencer Butler desktop app, the creator opens API Integrations, then DeepLink Routing, then Developer API access. They create a key named after your platform and receive an API key plus a secret.
They send you the key and secret
The secret is shown only once, so the creator copies it and passes both values to you through your normal secure onboarding. Store the secret encrypted, like a password.
You create their links
Call the API with those two headers. Every link you create lands in that creator's namespace, so it shows up in their own Deeplink Butler dashboard and analytics automatically.
Quickstart
Authenticate and create a link
Send both credentials as headers over HTTPS on every request. The base URL is https://links.influencerbutler.com.
Required headers
X-Api-Key: ibk_live_...X-Api-Secret: ibsk_live_...
Create a link
curl -sS https://links.influencerbutler.com/api/links \
-H "X-Api-Key: $IB_API_KEY" \
-H "X-Api-Secret: $IB_API_SECRET" \
-H "Content-Type: application/json" \
-d '{
"url": "https://www.amazon.com/dp/B0EXAMPLE",
"label": "Spring skincare pick"
}'You get back the branded short link:
{
"ok": true,
"slug": "aB3xQ7z",
"shortUrl": "https://links.influencerbutler.com/l/aB3xQ7z"
}Creating the same destination again returns the existing link withreused: trueinstead of a duplicate.
Scopes
Each key carries scopes
A call that needs a scope the key does not have returns403 insufficient_scope.
| Scope | Grants |
|---|---|
| links:write | Create links and publish routing. |
| links:read | List links, read stats, export click events. |
| links:heal | Repoint a link so posted copies self-heal. |
| pixels:write | Manage account-wide retargeting pixels. |
Endpoints
What you can call
| Method | Path | Scope | Purpose |
|---|---|---|---|
| POST | /api/links | links:write | Create or look up a branded short link (idempotent per destination). |
| GET | /api/links/list | links:read | List the creator's links, keyset paginated. |
| GET | /api/links/stats | links:read | Owner-scoped click analytics. |
| GET | /api/links/events | links:read | Per-click event export. |
| POST | /api/links/repoint | links:heal | Point an existing link at a new destination. |
| POST | /api/links/pixels | pixels:write | Save the creator's retargeting pixels. |
Errors
Predictable error codes
Every response is JSON. Success is{ ok: true, ... }; failure is{ ok: false, error }. Retry 429 and 5xx with backoff.
| Status | Code | Meaning |
|---|---|---|
| 400 | invalid_url | The destination was not a valid http(s) URL. |
| 401 | invalid_api_key | Missing, unknown, or revoked key, or a wrong secret. |
| 403 | insufficient_scope | The key lacks the scope this endpoint needs. |
| 404 | not_found | No such link in this creator's namespace. |
| 409 | target_in_use | Another of the creator's links already points there. |
| 429 | rate_limited | Slow down and honor the Retry-After header. |
Want to integrate your platform?
Ask the creators you work with to issue you a Developer API key from their Influencer Butler app, then start creating their links.