API Integration Guide – Getting Started

To begin using the API, you will need a few credentials and settings that are essential for authentication and access.

1. Get Your API Credentials

Login to the DSA Portal to generate your API credentials:

  • Api-Token
  • ClientId
  • UserName
  • Password
  • EndUserIp

These credentials are unique to your account and required for every API call.

2. Whitelist Your IP

To access the API securely, you must whitelist your public IP address in the DSA portal.

This ensures that only trusted IPs can use the API with your credentials.

3. Set Environment Variables

Once you have all the required details:

Replace the placeholders in the API documentation (like Api-Token) with your actual credentials.

You can use Postman's Environment feature to set these dynamically for convenience and better security.

{
"Api-Token": "your-api-token",
"ClientId": "your-client-id",
"UserName": "your-username",
"Password": "your-password",
"EndUserIp": "your-ip-address"
}
4. Authentication

This API uses API Token–based authentication.

All API requests must include the Api-Token in the request header.

Requests without a valid Api-Token will be rejected.

Required Header (Mandatory for Every API Call)
Api-Token: your-api-token
Content-Type: application/json

Important:

  • Api-Token must be included in every API request.
  • Keep your token secure and do not expose it in frontend code.
  • Regenerate the token from the DSA portal if it is compromised.
🛠️ Pro Tip: Keep your environment variables updated if any credential changes, or regenerate your token from the DSA panel when needed.

Now you're ready to start integrating with the API! 🚀

For any help, feel free to reach out to the support team.