Skip to main content

Authentication

The ReviewData Lite API uses API key authentication for all requests.

API Key​

Your API key is the primary method of authentication. If you need a new API key, please request one here.

Where to Include Your API Key​

The API key should be included in the request payload under the data.api_key field:

{
  "job": "App\\Jobs\\RequestReviews",
  "data": {
    "api_key": "your-api-key-here",
    "foreign_key": "12345",
    "lazy": true,
    "business": {
      // ... business data
    },
    "publishers": {
      // ... publisher configurations
    }
  }
}

API Key Format​

  • Length: Up to 128 characters
  • Format: Alphanumeric string
  • Example: ndsjwlb3.Hj70uPbf7dr1.............

Security Best Practices​

  1. Keep it Secret: Never expose your API key in client-side code or public repositories
  2. Environment Variables: Store your API key in environment variables
  3. Rotation: Regularly rotate your API key for enhanced security
  4. HTTPS Only: Always use HTTPS when making API requests

Getting Your API Key​

Your API key will be provided via email when your account is set up. If you need a new API key or have lost yours, contact support at techsupport@shoutaboutus.com.

Error Responses​

If authentication fails, you'll receive a 401 Unauthorized response:

{
  "error": "Invalid API key",
  "details": {
    "api_key": ["The provided API key is invalid"]
  }
}

Rate Limiting​

API requests are subject to rate limiting based on your subscription plan. If you exceed your rate limit, you'll receive a 429 Too Many Requests response.

Next Steps​

Now that you understand authentication, learn about the environments and how to configure your requests.