Get started

    API Endpoint

         "<datazapp api endpoint URL>"

This API takes the unique key provided by your account manager & returns your current account balance (number of available credits).

Reach out to your account manager or [email protected] to get the endpoint URL.

To use this API, you need an API key. Please contact us at [email protected] to get your API key.

Balance Check API Request

Query Parameters

Request                    
{
"ApiKey": "Your API Key"

}

Parameter	Type	Required	Description
APIKEY	String	(required)	Issued by sales support or Datazapp Admin

Response

Query Parameters

                    

Response

{
    "header": {
        "Status": 0,
        "Message": null
    },
    "ResponseDetail": "369.00",
    "Status": true,
    "Message": "Check Balance in ResponseDetail field."
}

Field	Type	Description
Following Parameters returned in Header:
Status	Integer	Indicate header status
Message	String	Indicate type of error
Matched	String	True=if matched, False=if not matched data
ResponseDetail	String	Current Balance
Status	String	True
Message	String	Error Message in case of any error.

Errors

The API uses the following error codes:

Error Code	Meaning
Module does not exist.	The specified module does not exist or Invalid AppendModule Name.
User not found.	Invalid API Key or The user associated with the API key was not found
Append Request not found	Invalid Token: The specified append request could not be found
Improper JSON Data. Please check.	The JSON data in the request does not match the expected format.
It seems like API has an issue. Please contact Support.	There is an issue with the API. Contact the [email protected]