Getting started API

Follow our step-by-step guide, from account registration to making your first call to our APIs.

To start using our APIs, you will need subscription keys for authentication. These keys are issued by our operations (ops) team upon request.

To request access:

  • Submit a ticket using this link: Get API product Access
  • Include the following details:
    • Your registered email address
    • The API(s) or product(s) you wish to access
    • A brief description of your intended use case

Our team will review your request and share the subscription keys required to make authenticated API calls.

Once you have your subscription keys, you are ready to connect.

Heres how to get started:

  • Review the API documentation to understand available endpoints, required parameters, and expected responses.
  • Include your key in the request header as shown below:
    • Ocp-Apim-Subscription-Key: your-key-here
  • Use tools like Postman, cURL, or your preferred code environment to begin testing.

We recommend validating your setup using the built-in Try It feature in the Developer Portal. This allows you to make real-time API requests directly from your browser no setup required.

Alternatively, you can use Postman or similar tools to test:

  • Ensure all headers and parameters are correctly configured
  • Confirm your subscription key is valid
  • Use the API documentation for troubleshooting tips

If something doesnot work as expected, check your request format or reach out to our support team for help.

Using JWT to Access Our APIs

JWT Web tokens will be used as mechanism to provide authorization for applications/APIs. This document provides a step-by-step overview how to obtain an access token to call our API Products protected by JWT WEB Tokens.

You need a mechanism to generate JWT tokens. This could be done by an authentication server, identity provider, or any system capable of generating JWTs securely.
In your API Management system, define API products. These are logical groupings of APIs with specific access rules, quotas, and rate limits.
API products typically allow you to attach policies. Policies define the behavior and rules associated with accessing the APIs within the product. You would attach a policy to enforce JWT token validation.
Configure a policy at the product level to validate JWT tokens. This policy should include:
  • JWT token validation parameters such as issuer, audience, expiration time, etc.
  • Public key or certificate for verifying the signature of the JWT token (if asymmetric encryption is used).
  • Claims required for access (e.g., user roles, scopes, etc.).
When developers subscribe to your API products, they would typically receive a JWT token along with their subscription. This token will be used to authenticate and authorize their requests to the APIs within that product.
Configure your API gateway or management system to enforce the JWT token validation policy for requests coming in for APIs associated with the product.
Implement appropriate error handling for cases where JWT validation fails. This could include returning HTTP 401 Unauthorized responses or redirecting users to authentication endpoints.
By implementing JWT tokens at the product level in your API Management system, you can control access to your APIs based on the subscription plans or access levels assigned to developers. This allows for fine-grained access control and enables you to enforce security policies consistently across your APIs.
FAQs

Ready to deploy APIs? Have questions? Take a look at some of the most frequently asked questions from developers.

Maximum of 20 apps are possible for each developer.
Yes. Up to 15 API keys per app are possible.
It doesnot expire. The developer can revoke and recreate keys as needed.
A mock service simulates API requests and responses for evaluation and testing purposes. Our mock services are based on actual scenarios that allow developers to quickly determine if the API Product is suited to their needs and integrate our APIs without external dependencies.