layout: default title: API Reference permalink: /api-reference/

API Reference

Complete documentation for the ViewFi API.

Base URL

https://video-rewards.com/api

Authentication

All API requests require authentication using your API key:

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

Endpoints

Campaign Management

• GET /campaigns - List all campaigns
• POST /campaigns - Create new campaign
• GET /campaigns/{id} - Get campaign details
• PUT /campaigns/{id} - Update campaign
• DELETE /campaigns/{id} - Delete campaign

Widget Integration

• GET /widget/campaigns/{id} - Get campaign for widget
• POST /widget/campaigns/{id}/view - Track video view
• POST /widget/campaigns/{id}/claim - Process reward claim

Analytics

• GET /analytics/campaigns/{id} - Campaign analytics
• GET /analytics/dashboard - Dashboard overview

Response Format

All API responses follow this structure:

{
  "success": true,
  "data": {...},
  "error": null
}

Error Handling

Error responses include detailed information:

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid campaign parameters"
  }
}

Rate Limits

• 1000 requests per hour per API key
• Burst limit: 100 requests per minute

SDKs and Examples

Check our developer resources for SDKs and code examples.