GSP Utility API
If using UCL or FREE TaxPro API Library, Reference: Assembly: TaxProGST.API
1. GetApiBalance
HTTP Method: GET
Headers or QueryString Parms:
|
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
|
Response in below Type:
public class AspApiBalance
{
public int ApiBal { get; set; }
public DateTime ApiBalExpDt { get; set; }
}
Sample Url:
https://gstapi.charteredinfo.com/aspapi/v1.0/getapibalance?aspid=<===YourAspId===>&password=<===YourPassword===>
2. SetASPPubCer
Used to update newly generated Public Key (".cer" file) to ASP Account.
HTTP Method: POST
Headers:
|
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
|
Body: Content of Cer File (By replacing -----BEGIN CERTIFICATE----- and -----END CERTIFICATE-----)
Success Response: HttpStatusCode.OK (200)
Download API Txn Log for the date indicated by Query Parameter TxnDt.
HTTP Method: GET
Headers or Query 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
|
|
TxnDt
|
Transaction Date [ddMMMyy]
|
string
|
Query Parameter:
TxnDt=ddMMMyy (ex: 02APR18)
Sample Url:
https://gstapi.charteredinfo.com/aspapi/v1.0/dailytxnlog?
---------------
