For developers

Build custom affiliation workflows

Sprusify's REST API and webhook events let you integrate affiliate management into your systems. Build custom attribution, automation, and reporting.

View API docs Quick start

API basics

RESTful endpoints

Standard REST API with JSON request/response. All endpoints are authenticated with API keys.

GET /api/v2/affiliates

POST /api/v2/campaigns

PUT /api/v2/conversions/:id

DELETE /api/v2/commissions/:id

Full endpoint reference

Authentication

API key authentication with Bearer token. Keys can be scoped to specific actions and resources.

Authorization: Bearer

sk_live_xxxxxxxxxxxxx

Learn about auth

Common use cases

Build custom tracking

Send custom conversion events or adjust attribution on-the-fly.

POST /conversions
{"clickId": "...",
"value": 150.00}

Conversions API

Bulk affiliate import

Import affiliates in bulk from another system.

POST /affiliates/import
{"file": "...csv",
"program": "..."}

Bulk API

Sync to data warehouse

Export affiliate data and commission history for analysis.

GET /commissions?
date_from=2025-01-01

Export API

Automate payouts

Approve and schedule payouts programmatically.

POST /payouts
{"affiliates": [...],
"scheduled": true}

Payouts API

Manage commission rules

Create and update commission structures via API.

POST /commission-rules
{"type": "percentage",
"value": 15}

Commission API

Listen for events

React to affiliate or conversion changes in real time.

webhook:
affiliate.created
conversion.confirmed

Webhooks API

API features

Performance & scale

Sub-100ms response times
Batch endpoints for bulk operations
Pagination support for large datasets
Rate limiting (5,000 req/min per key)
Global CDN for low latency

Reliability & security

99.9% uptime SLA
Webhook retry logic & durability
Request signing & validation
IP whitelisting support
Audit logging for all API calls

SDK & libraries

Official SDKs

JavaScript / TypeScript
Python
Node.js
Go
PHP

View all SDKs

Postman collection

Import our Postman collection for quick testing and exploration.

Open in Postman

Code examples

Real-world examples for common operations in multiple languages.

View examples

Get started with the API

1

Create an API key

Generate a key in your account settings with appropriate scopes.
2

Read the docs

Review the API reference and authentication guide.
3

Try the sandbox

Test your integrations in our sandbox environment.
4

Deploy to production

Switch API keys and go live with confidence.

Support & resources

Complete API documentation
Endpoint reference, authentication, and best practices
Developer support
Email, Slack, and community forum
Error handling guide
Common errors and troubleshooting
Rate limits & quotas
Understand API throttling and best practices

Start growing with partners

Turnkey Shopify affiliate tracking, payouts, and fraud checks - ready for production.

Get started