1. Data Service APIs
AppZen provides APIs for Invoice documents, Supplier, purchase order, Invoice audit results, search Invoice audit, and bulk import. AppZen API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON responses, and uses standard HTTP response codes, and verbs.
These APIs can be used against below environments with following details:
SBUS https://api.us.sandbox.AppZen.com
EU http://eu-api.AppZen.com/dictionary-data-services
2. Authentication
AppZen uses BSI (Boutique System Integrator) partners for customer implementations. BSI uses AppZen’s APIs to complete all integrations for historical data ingestion and transactional integrations.
Authentication for AppZen Integration:AppZen uses API Key mechanism to validate calls to the API. It uses customer_id and API Key combination to allow the access to the public API's).
API Key Based Authentication: In order to consume APIs protected using an API-Key, integration developers will use the API Key Based Authentication security policy.
REST Adapter provides an extensible interface for developers to declaratively define how the API Key needs to be sent as part of the request. During API invocation, the adapter will inject the API-Key as specified in the API Key Usage along with the request.
Sample Call to AppZen:
Authentication for these APIs are done based on following fields:
-
customer-id: customer will have a unique value for this field.
-
x-api-key: Each partner/integration will have a unique value for it. Same value has to be used for all customers belonging to a particular integration.
-
customer-key: Each customer will have a unique value for this field.
3. Status Codes
Here are some of the common status codes used by AppZen Autonomous AP.
|
Code |
Message |
Meaning |
|
200 |
OK |
Everything worked as expected. |
|
201 |
Created |
Request was Created |
|
400 |
Bad Request |
The request was unacceptable, often due to missing a required parameter |
|
401 |
Unauthorized |
No valid authentication (e.g.: Customer Key could be missing/invalid) |
|
403 |
Forbidden |
The x-api key doesn’t have permission to perform the request |
|
404 |
Not Found |
The request resource doesn’t exist |
|
500 |
Internal Server Errors |
Something went wrong on AppZen’s end |
|
429 |
Too Many Requests |
Available quota/limit already consumed |
Note: AppZen allows 1,000 requests per second and 300,000 requests per day. If you are exceeding either off-limits, you’ll get an HTTP 429 error.
We provide APIs for documents, suppliers, purchase orders, invoice audit results, search invoice audits, and bulk import. Data services information is listed in Swagger. For the most up-to-date information please refer to the documentation here.
Comments
Please sign in to leave a comment.