API Overview

Introduction

Refgrow provides a RESTful API that allows you to integrate affiliate tracking and management functionality directly into your applications. The API enables you to track conversions, manage affiliates, retrieve statistics, and automate workflows.

The API is organized around REST principles. All requests should be made over HTTPS, and most API actions return JSON-encoded responses. Error responses include descriptive messages to help identify issues.

Base URL

The base URL for all API requests is:

https://refgrow.com/api/v1

Authentication

Authentication to the API is performed via API keys. Each request must include your API key in the Authorization header.

const headers = {
  'Authorization': 'Bearer YOUR_API_KEY',
  'Content-Type': 'application/json'
};

For more details on obtaining and using API keys, see the Authentication documentation.

Available Endpoints

Refgrow API provides several endpoint categories:

Program Management

Affiliate Management

Tracking

Coupons

Conversions Management

Rate Limits

To ensure service stability, API requests are subject to rate limiting. Current limits are:

• 100 requests per minute per IP address
• 1000 requests per hour per API key

When a rate limit is exceeded, the API will return a 429 Too Many Requests response with a Retry-After header indicating when you can resume making requests.

Error Handling

The API uses conventional HTTP response codes to indicate success or failure of requests:

• 2xx - Success
• 4xx - Client errors (invalid parameters, authentication issues)
• 5xx - Server errors

Error responses include a JSON object with error details:

{
  "error": {
    "code": "invalid_parameters",
    "message": "Missing required parameter: program_id",
    "status": 400
  }
}

Example Requests

Below is an example of how to make a request to track a conversion:

// Example Node.js code for creating a conversion
const axios = require('axios');

async function createConversion() {
  try {
    const response = await axios.post('https://refgrow.com/api/v1/conversions', {
      customer_email: 'customer@example.com',
      amount: 49.99,
      referral_code: 'REF123'
    }, {
      headers: {
        'Authorization': 'Bearer YOUR_API_KEY',
        'Content-Type': 'application/json'
      }
    });

    console.log('Conversion created:', response.data);
  } catch (error) {
    console.error('Error creating conversion:', error.response ? error.response.data : error.message);
  }
}

Next Steps

To learn more about specific API endpoints and functionality, explore these resources:

• Authentication Guide - Detailed information on API authentication
• API Endpoints - Complete reference for all available endpoints
• Webhooks - Set up real-time notifications for events in your affiliate program