API Reference

Build powerful integrations with our RESTful API

v1.0 REST

Quick Links

SDKs

Authentication

All API requests require authentication using an API key.

GET /api/v1/affiliates
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Affiliates

List Affiliates

Retrieve a list of all affiliates in your account.

GET /api/v1/affiliates

Response:
{
  "data": [
    {
      "id": "aff_123",
      "email": "affiliate@example.com",
      "status": "active",
      "commission_rate": 15.00,
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "total": 42,
  "page": 1
}

Create Affiliate

POST /api/v1/affiliates
{
  "email": "new@affiliate.com",
  "program_id": "prog_456",
  "commission_rate": 20.00
}

Response:
{
  "id": "aff_789",
  "tracking_code": "AFF-DEMO-789",
  "status": "pending"
}

Programs

Manage your affiliate programs via API.

GET /api/v1/programs

Response:
{
  "data": [
    {
      "id": "prog_123",
      "name": "Summer Sale Program",
      "commission_type": "percentage",
      "commission_rate": 15.00,
      "cookie_duration": 30,
      "status": "active"
    }
  ]
}

Webhooks

Receive real-time notifications for events.

Available Events:

affiliate.created
affiliate.approved
sale.created
commission.earned
commission.paid

Full Documentation

For complete API documentation with all endpoints, parameters, and examples, visit our interactive API explorer.