Troubleshooting Common Issues

Authentication Errors

If you're encountering authentication issues, ensure your API keys are correctly configured and have the necessary permissions. Check for typos in your requests and verify the expiration date of your tokens.

Common Cause: Invalid API Key

Problem: Getting a `401 Unauthorized` error.

Solution:

  • Double-check that your API key is correctly copied and pasted.
  • Verify the key is enabled in your developer dashboard.
  • Ensure you are using the correct authentication method (e.g., Bearer token, Basic Auth).

Example header for Bearer token:

Authorization: Bearer YOUR_API_KEY

Rate Limiting

Our API has rate limits to ensure fair usage. If you hit these limits, you'll typically receive a 429 Too Many Requests response. Implement exponential backoff in your retry logic.

Heads up! Exceeding rate limits can temporarily block your access. Monitor your request frequency.

Handling Rate Limit Responses

When you receive a 429 error:

  • Read the Retry-After header if available, which indicates how long to wait before retrying.
  • If Retry-After is not present, wait for a progressively longer period before your next attempt (e.g., 1s, 2s, 4s, 8s).
  • Consider optimizing your requests to reduce unnecessary calls.

Data Formatting Issues

Ensure that the data you send in your requests conforms to the expected JSON or form-data structure. Incorrectly formatted payloads can lead to `400 Bad Request` errors.

Validating Input Data

Before sending a request:

  • Consult the API documentation for the exact schema and data types of each field.
  • Use a JSON validator to check your payload structure.
  • Ensure all required fields are present and correctly formatted.

Example of a valid JSON payload for creating a user:

{ "name": "Jane Doe", "email": "jane.doe@example.com", "isActive": true }

Connectivity Problems

If you're unable to connect to our API endpoints, check your network connection, firewall settings, and ensure you are using the correct API base URL.

Network Issue: Cannot reach the API server. Verify your internet connection and proxy settings.

Unexpected Responses

If you receive an unexpected response code or data structure, please check the latest API documentation for any recent changes. If the issue persists, don't hesitate to contact our support team.

Forums & Community: Engage with other developers in our Community Forum to find solutions or share your experiences.