This page provides an understanding of how the APIs behave.
AppZen APIs are organized around REST as follows:
- The API accepts form-encoded request bodies.
- It returns JSON-encoded responses.
- It uses standard HTTP response codes and verbs.
Request and Response structure
The requests to AppZen APIs must be sent to the base URL:
https://api.appzen.comFor the EU, the requests must be sent to:
For a particular call, append the base URL with the name of the resource. Some of the endpoints may contain Path Parameters.
AppZen APIs use the standard HTTP Verbs/Methods.
Select the suitable method:
GET or POST based on the action to be performed.
AppZen APIs use headers for authentication. AppZen supports OAuth1.0 based authentication. For more details refer to Authentication.
The request body supports JSON payloads.
The Standard HTTP response headers are returned.
The response body is in JSON format returning the success or failure information.
The endpoints in the AppZen APIs, return standard HTTP status codes for successful or unsuccessful operations. The following table describes the common response codes:
|200||The request is successful.|
The request is successful.
The request failed due to a malformed request syntax. Check the requested URL, including the parameters.
The request failed due to an authorization issue. For example, the Customer Key could be missing or invalid.
The request failed due to a permission issue. The x-api key may not have permission to perform the request.
The request failed as the resource is not found. Check the requested URL.
The request failed due to an AppZen server issue.
The request failed as the available quota/limit has been consumed.
Rate Limit of 20 per sec for each data type.