e-Invoice Authentication
Users have to authenticate themselves to call e-Invoice APIs
Overview
Users have to authenticate themselves using their e-Invoice portal credentials to call the e-Invoice APIs
Endpoint
| HTTP Method | Resource |
|---|---|
POST |
Request
Follow the below guidelines to call the API.
Body
| Param | Type | Description | Example |
|---|---|---|---|
| UserName | string | Username of Tax payer as created on E-Invoice portal for API Integration | testuser |
| Password | string | Password of Tax payer as in E-Invoice portal for API Integration | Password in plain text |
| AppKey | string | Any random 32 bytes array, generated by user. On converting to String using base 64 encoding will be 44 chars long. | Randomly generated key |
| ForceRefreshAccessToken | Boolean | The value of this attribute to be set true, if client needs to refresh the token 10 minutes before expiry | true |
Sample CURL Request
curl --request POST \
--url https://api.sandbox.co.in/ \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'x-api-version: 1.0' \
--data '
{
"UserName": "testuser",
"Password": "<Password in plain text >",
"AppKey": "<Randomly generated key>",
"ForceRefreshAccessToken": true
}
'
Test Environment Not Available
Response
| Param | Type | Description | Example |
|---|---|---|---|
| Status | num | Status of the authentication request (values 1-Success and 0- Failure) | 1 |
| ClientId | string | Client Id | testclientid |
| UserName | string | User Name | testuser |
| AuthToken | string | Authorization token | 5GGo3hKqPSvbHwRImTjIxeMKQ |
| Sek | string | Session Encryption Key generated using AES 256(AES/ECB/PKCS7Padding) algorithm. Encrypted () with AppKey | EmLpFzYohZLstcXCSX9C9XIHVLb+QcsjMO1mk+qAjW8hyXmEBQnCAYsmbluFFu+Z |
| TokenExpiry | string | Token Expiry time. Date format is ‘yyyy-MM-dd HH:mm:ss ’ | 2019-11-30 14:18:00 |
Response Caching
Response caching is not available for this API. Learn more about our response caching mechanism here
Wallet Charges
Since E-Invoice Authentication API is a Paid API, a wallet charge will take place.
Versioning
This API is currently in major version 1.0. Refer to our versioning policies here
Updated 2 months ago