Skip to main content

Authentication & Mock Data

API Authentication​

Our API uses a secure authentication system based on API keys. To access our services, you'll need to:

  1. Obtain your unique API key from our platform
  2. Include this key in each request using the x-api-key header

Example Header:

x-api-key: your_api_key_here

Testing with Mock Data​

To facilitate your implementation and testing process, we've created a mock data feature that doesn't consume your credits.

How to Use Mock Mode​

Simply add the mock-mode header with a value of true to your requests:

Example Header:

mock-mode: true

Benefits of Mock Mode​

  • Receive realistic sample responses that match the structure of production data
  • Test your implementation thoroughly without using credits
  • Validate your integration before moving to production

Important Notes​

  • Mock data is only available for specific endpoints (see API Reference for details)
  • In production mode (without mock-mode header), each request will consume credits according to your plan
  • The structure of mock responses matches real responses, but contains synthetic data

Need further assistance? Contact our support team for help with authentication or mock data.