URL Based API
To make some of the GST Public APIs and GSP APIs more easy to consume for Developers, we have provided few of GET APIs through simple GET URL.
Below is the details for integrating GSP APIs and Search GST TaxPayer API with TaxPro GSP through URL based API. Other GST API are TaxPayer specific and requires end-to-end TaxPayer authorized and encrypted session to GSTN servers and hence its not possible to provide those API in this simple form.
Steps:
2. Invoke below URL (API) to GET the required data by passing ASPID, ASP Password along with GSTIN.
1. Search GST TaxPayer Public API:
https://gstapi.charteredinfo.com/commonapi/v1.1/search
Headers Parameters
|
Property
|
Description
|
Data Type
|
|
aspid
|
AspUserId provided by GSP.
|
String
|
|
asp-secret
|
Encrypt AspPassword (Asp Secret Key) provided by GSP for pass through API access, Encrypted using AspEK (received in GetKey API)
Sample:
request.AddHeader("asp-secret", AesEncryptBase64(“Asp Secret Key”,AspEK)) [Algorithm: AES/ECB/PKCS7]
|
String
|
|
session-id
|
SessionID. ASP may create multiple Sessions.
|
string
|
|
txn
|
Unique Transaction ID even if calling GSP Service API. (Requires only once, which you are already passing as requirement for GST API.)
|
string
|
|
appver
|
Application Name and Version calling API. (Optional but Recommended)
|
string
|
|
Content-Type
|
application/json; charset=utf-8
|
string
|
|
ip-usr
|
123.123.123.123
|
string
|
Query Parameters
|
Property
|
Description
|
Data Type
|
|
action
|
"TP" - set to value TP for Search TaxPayer Action.
|
String
|
|
gstin
|
GSTIN of API Caller (under which API would be Loged).
|
String
|
|
searchgstin
|
GSTIN of TaxPayer to Search for.
|
String
|
2. GST Return Status Pulbic API:
https://gstapi.charteredinfo.com/commonapi/v1.0/returns
Headers Parameters
|
Property
|
Description
|
Data Type
|
|
aspid
|
AspUserId provided by GSP.
|
String
|
|
asp-secret
|
Encrypt AspPassword (Asp Secret Key) provided by GSP for pass through API access, Encrypted using AspEK (received in GetKey API)
Sample:
request.AddHeader("asp-secret", AesEncryptBase64(“Asp Secret Key”,AspEK)) [Algorithm: AES/ECB/PKCS7]
|
String
|
|
session-id
|
SessionID. ASP may create multiple Sessions.
|
string
|
|
txn
|
Unique Transaction ID even if calling GSP Service API. (Requires only once, which you are already passing as requirement for GST API.)
|
string
|
|
appver
|
Application Name and Version calling API. (Optional but Recommended)
|
string
|
|
Content-Type
|
application/json; charset=utf-8
|
string
|
|
ip-usr
|
123.123.123.123
|
string
|
Query Parameters
|
Property
|
Description
|
Data Type
|
|
action
|
"RETTRACK"
|
String
|
|
gstin
|
GSTIN of TaxPayer to Search for.
|
String
|
|
fy
|
Financial Year (YYYY-YY)
|
String
|
|
type (Optional)
|
R1 or R2, etc
|
String
|
3. Get API Balance:
https://gstapi.charteredinfo.com/aspapi/v1.1/getapibalance
Header Parameter: aspid=ASPID, password : {ASPAcPassword}
4. Get API Settings:
https://gstapi.charteredinfo.com/aspapi/v1.0/getapisetting
Header Parameter: aspid=ASPID
5. Daily API Transaction Log:
https://gstapi.charteredinfo.com/aspapi/v1.0/dailytxnlog?TxnDt=DateOfLogsToBeDownloaded
Header Parameter: aspid=ASPID, password : {ASPAcPassword}
Provide value of url query paramater and header parameter in above urls - marked as BOLD.
Parameters & Values
1. aspid=ASPID (Registered ASPID Received from TaxPro GSP) [Pass only in Header]
2. password=ASPAcPassword (given by you at the time of Registration) [Pass only in Header]
3. Gstin=GSTINOfTaxPayerToSearch – GSTIN to be searched
4. TxnDt=DateOfLogsToBeDownloaded – format DDMMMYY (01Jan17)
Response to the Search GST TaxPayer API Call will be as below
|
Search TaxPayer
|
|
Details
|
Respective Key (Item)
|
Response Sample
|
|
Registration Date
|
rgdt:
|
01/07/2017
|
|
Company Type
|
ctb:
|
Private Limited Company/ Limited Company..
|
|
Constitution of Business
|
sts:
|
Active/ Inactive
|
|
Legal Name
|
lgnm:
|
ABC Corporation LTD.
|
|
State Jurisdiction
|
stj:
|
Jalandhar
|
|
GSTIN
|
gstin:
|
11AAAAA2222Q1Z2
|
|
Nature of Business Activity
|
nba:
|
Recipient of Goods or Services/Wholesale Business
|
