Evangeler API Documentation

Table of Contents

Authentication

All API requests require authentication using a Bearer token in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Your API key:

You can find your API key in your account dashboard after logging in.

Rate Limits

API requests are limited to:

tolt.js - JavaScript Tracking Library

Include tolt.js on your website to automatically track referrals and conversions:

<script src="https://yourdomain.com/static/js/tolt.js" data-tolt-key="YOUR_API_KEY"></script>

Manual Tracking

// Track a conversion
Tolt.trackConversion({
    amount: 99.99,
    order_id: 'ORDER-123'
});

// Track a customer
Tolt.trackCustomer({
    email: '[email protected]',
    name: 'John Doe'
});

// Track a transaction
Tolt.trackTransaction({
    id: 'TXN-123',
    amount: 99.99,
    customer_id: 'CUST-123'
});

Partners

GET List Partners

/api/v1/partners

Query Parameters:

page integer - Page number (default: 1)
per_page integer - Items per page (default: 20) 
{
    "data": [...],
    "total": 100,
    "page": 1,
    "per_page": 20,
    "has_more": true
}

GET Retrieve Partner

/api/v1/partners/:id

POST Create Partner

/api/v1/partners

{
    "email": "[email protected]",
    "name": "John Doe",
    "company": "Acme Inc",
    "commission_rate": 20.0,
    "commission_type": "percentage",
    "cookie_duration": 30
}

PUT Update Partner

/api/v1/partners/:id

DELETE Delete Partner

/api/v1/partners/:id

Customers

GET List Customers

/api/v1/customers

GET Retrieve Customer

/api/v1/customers/:id

POST Create Customer

/api/v1/customers

{
    "email": "[email protected]",
    "name": "Jane Smith",
    "partner_id": 123
}

PUT Update Customer

/api/v1/customers/:id

DELETE Delete Customer

/api/v1/customers/:id

Clicks

POST Create Click

/api/v1/clicks

{
    "link_code": "ABC123",
    "ip_address": "192.168.1.1",
    "user_agent": "Mozilla/5.0...",
    "referer": "https://example.com"
}

GET List Links

/api/v1/links

GET Retrieve Link

/api/v1/links/:id

POST Create Link

/api/v1/links

{
    "partner_id": 123,
    "url": "https://yoursite.com/special-offer",
    "name": "Special Offer Link"
}

PUT Update Link

/api/v1/links/:id

DELETE Delete Link

/api/v1/links/:id

Commissions

GET List Commissions

/api/v1/commissions

Query Parameters:

status string - Filter by status (pending, approved, paid, cancelled)

GET Retrieve Commission

/api/v1/commissions/:id

POST Create Commission

/api/v1/commissions

{
    "partner_id": 123,
    "amount": 25.00,
    "status": "pending",
    "description": "Commission for order #1234"
}

PUT Update Commission

/api/v1/commissions/:id

DELETE Delete Commission

/api/v1/commissions/:id

Transactions

GET List Transactions

/api/v1/transactions

GET Retrieve Transaction

/api/v1/transactions/:id

POST Create Transaction

/api/v1/transactions

{
    "customer_id": 456,
    "amount": 99.99,
    "currency": "USD",
    "status": "completed",
    "description": "Purchase of Premium Plan"
}

PUT Update Transaction

/api/v1/transactions/:id

DELETE Delete Transaction

/api/v1/transactions/:id

Promotion Codes

GET List Promotion Codes

/api/v1/promotion-codes

GET Retrieve Promotion Code

/api/v1/promotion-codes/:id

POST Create Promotion Code

/api/v1/promotion-codes

{
    "code": "SAVE20",
    "discount_type": "percentage",
    "discount_value": 20.0,
    "max_uses": 100,
    "expires_at": "2024-12-31T23:59:59Z"
}

PUT Update Promotion Code

/api/v1/promotion-codes/:id

DELETE Delete Promotion Code

/api/v1/promotion-codes/:id