Authenticate
Generate access token required to call Sandbox APIs
Overview
The API takes API key
and secret
and returns JWT access_token
which is required to use Sandbox APIs
Endpoint
HTTP Method | Resource |
---|---|
POST | /authenticate |
Request
Follow the below guidelines to pass API key
& secret
in the request header.
Header
Header | Type | Description | Example |
---|---|---|---|
x-api-key | string | An API key is a public key to identify users when calling any Sandbox API. | key_live_ZUQT5UEf4RCU7wGafzvDVXXwYYsz58XP |
x-api-secret | string | A secret key is a private key to authenticate your access to the given API request. | secret_live_12345AbCDe....... |
Sample CURL Request
curl --request POST \
--url https://api.sandbox.co.in/authenticate \
--header 'accept: application/json' \
--header 'x-api-key: key_xxxxxxxxxxxxxxx' \
--header 'x-api-secret: secret_xxxxxxxxxxx' \
--header 'x-api-version: 1.0'
Access Token will be valid for only 24 hours
Use Authorize API for refreshing it.
Test Environment Available
Response
Param | Description | Example |
---|---|---|
access_token | The JWT Access Token, which is required for calling all the Sandbox APIs. | eyJhbGciOiJIUzUxMiJ9.eyJhdWQ.......... |
Response Caching
Response caching is not available for this API. Learn more about our response caching mechanism here
Wallet Charges
Since Authenticate API is not a Paid API, no wallet charge will take place.
Versioning
This API is currently in major version 1.0. Refer to our versioning policies here
Updated about 1 month ago