API Integration Guide

Connect your applications with RateAds API

RateAds API Overview

Programmatic access to your advertising data

The RateAds API allows you to integrate your advertising data into your own applications, dashboards, and workflows. Access campaign performance, ratings, reviews, and analytics programmatically.

Getting Started

Set up your API access

Generate API Key

Go to Settings → API Access in your advertiser dashboard. Click "Generate New API Key" to create your authentication credentials.

Review Documentation

Read the complete API documentation at api.rateads.us/docs to understand available endpoints, request formats, and response structures.

Test Your Integration

Use the sandbox environment to test your integration before connecting to production. All test requests are free and don't count toward limits.

Go Live

Once testing is complete, update your application to use production API endpoints and start accessing real data.

API Capabilities

What you can do with the RateAds API

Campaign Management

Create, update, and manage advertising campaigns programmatically. Upload creative assets and configure targeting settings via API.

Analytics Retrieval

Fetch performance metrics, ratings data, and engagement statistics. Build custom dashboards with real-time data.

Review Management

Retrieve reviews and ratings for your ads. Post responses and monitor sentiment trends programmatically.

Webhooks

Receive real-time notifications when users rate your ads, post reviews, or when performance thresholds are met.

Authentication

Securing your API requests

API Key Authentication

Include your API key in the Authorization header of every request:

Authorization: Bearer YOUR_API_KEY

Security Best Practices

• Never expose API keys in client-side code
• Rotate keys regularly (every 90 days recommended)
• Use environment variables to store credentials
• Monitor API usage for suspicious activity
• Revoke keys immediately if compromised

Rate Limits & Quotas

Understanding API usage limits

API rate limits vary by subscription plan:

Basic Plan: 1,000 requests per hour
Professional Plan: 10,000 requests per hour
Enterprise Plan: Custom limits based on your needs

If you exceed your rate limit, requests will return a 429 status code. Implement exponential backoff in your integration to handle rate limiting gracefully.

Example Integration

Quick start code example

Fetching Campaign Analytics (JavaScript)

const fetchCampaignAnalytics = async (campaignId) => {
  const response = await fetch(
    `https://api.rateads.us/v1/campaigns/${campaignId}/analytics`,
    {
      headers: {
        'Authorization': `Bearer ${process.env.RATEADS_API_KEY}`,
        'Content-Type': 'application/json'
      }
    }
  );

  if (!response.ok) {
    throw new Error(`API error: ${response.status}`);
  }

  const data = await response.json();
  return data;
};

// Usage
try {
  const analytics = await fetchCampaignAnalytics('campaign-123');
  console.log('Average Rating:', analytics.averageRating);
  console.log('Total Reviews:', analytics.totalReviews);
} catch (error) {
  console.error('Failed to fetch analytics:', error);
}

Webhook Configuration

Receive real-time event notifications

Setting Up Webhooks

1. Go to Settings → API Access → Webhooks
2. Click "Add Webhook Endpoint"
3. Enter your endpoint URL (must be HTTPS)
4. Select events you want to receive
5. Save and verify the webhook

Available Webhook Events

• rating.created - New rating submitted
• review.created - New review posted
• campaign.performance_alert - Performance threshold met
• brand.verified - Brand verification completed

API Support

Get help with your integration

Need help integrating the RateAds API? Our developer support team is ready to assist with technical questions and troubleshooting.

View API Docs Account Settings