API Reference Overview

Introduction

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

Request Structure

Request URI

The requests to AppZen APIs must be sent to the base URL:
https://api.appzen.com
For the EU, the requests must be sent to:
https://eu-api.appzen.com

For a particular call, append the base URL with the name of the resource. Some of the endpoints may contain Path Parameters.
Example: https://api.appzen.com/dictionary-data-services/invoice/{{uuid}}/audit-results

Request Method

AppZen APIs use the standard HTTP Verbs/Methods.
Select the suitable method: GET or POST based on the action to be performed. 

Request Headers

AppZen APIs use headers for authentication. AppZen supports OAuth1.0 based authentication.  For more details refer to Authentication.

Request Body

The request body supports JSON payloads.

Response Structure

Response Headers

The Standard HTTP response headers are returned.

Response Body
The response body is in JSON format returning the success or failure information.

Response Codes

The endpoints in the AppZen APIs, return standard HTTP status codes for successful or unsuccessful operations. The following table describes the common response codes:

Rate Limit

Rate Limit of 20 per sec for each data type.

See Also

• Introduction
• API List