Authorization - API Key


API Key Authorization and Usage Control

Purpose:

Your API key identify your Account and your subscriptions to our APIs.

How it Works:

  1. Obtain an API Key:

  2. Include the API Key in the Request Header:

    • The client application includes the API key in a custom header (x-api-key) in each API request.

Why it's Needed:

  • To manage and control API usage.

  • To implement different pricing tiers or usage limits.

  • To prevent abuse and ensure fair usage.

  • To track API usage and monitor performance.

How to Use in Postman:

  1. Add API Key Header:

    • Go to the "Headers" tab in Postman.

    • Add a new header with the following:

      • Key: x-api-key (or the name you configured in API Gateway or your api's configuration)

      • Value: Paste your API key value.

Example Request Headers: