Development
This phase focuses on designing your integration strategy and beginning active development using the AFS API documentation. You will need to identify which endpoints and data flows are needed to meet your business objectives and begin constructing the client that will handle API requests and responses.
Please refer to the product specific API documentation during this stage:
Define Integration Flow
Identify which product APIs and endpoints your use case requires and document your end-to-end flow including request triggers, data inputs, expected outputs, and error handling.
Explore & Develop
Once the use case is defined, build out the appropriate sequence of API calls, and begin client-side development using your UAT credentials. The product specific API documentation allows you to make live test calls directly from the reference pages. Use this to experiment with inputs, observe outputs, and understand how each endpoint behaves.
Implement Error Handling
Standard HTTP response codes are used to indicate the success or failure of an API request. These codes help identify whether a request was successful, encountered a client-side issue, or failed due to a server-side error.
Always inspect the response body for additional context or error messages, which may provide details about how to resolve the issue.
|
Status Code |
Meaning |
Description |
|---|---|---|
|
200 |
OK |
The request was successful. |
|
400 |
Bad Request |
The request parameters were missing or unacceptable. |
|
401 |
Unauthorized |
The API key was not provided or the key is expired or invalid. |
|
402 |
Request Failed |
The request parameters were valid but could not be processed. |
|
403 |
Forbidden |
The API key was provided but does not have permission to perform the requested operation. |
|
404 |
Not Found |
The requested resource could not be found or does not exist. |
|
500, 502, 503, 504 |
Server Error |
A generic server error occurred. This is usually not caused by the client request. Please try again later or contact support. |
Interpret Responses
Some API responses include codes or values that are not immediately intuitive. To assist with development and troubleshooting, review the following reference tables for details on how to interpret responses from each product.