What is an API?
|
An API (Application Programming Interface) allows digital devices, software applications, and data servers to talk with each other. According to PostMan, "API integration is simply the connection between two (or more) applications, programs, services, or systems, using APIs. Applications use APIs to send and receive data and content between each other." Therefore, the AroFlo API is a mechanism to pull data out of your AroFlo and have it inserted into another piece of software for you to manipulate as you wish, within the bounds of what the API is capable of and our Terms of Use. |
 |
|
The AroFlo API is designed to allow Accounting and job management software like SAP to connect to AroFlo to retrieve and update information, much like our integration with other accounting packages like XERO and MYOB. This page allows you to retrieve or regenerate your access details.
Who Should Access the AroFlo API?
Like any computer programming-related activity, it's recommended only for those with at least a moderate understanding of software development to attempt to use the AroFlo API.
API Terms of Use
Please see our API Terms of Use before accessing and using the AroFlo API.
Request API Access
To access the AroFlo API, go to Site Administration > Settings > General > AroFlo API.
If you don't already have access to AroFlo's API, please send us a support request, stating that you need API access.
API Access Details
Once API access has been enabled, you can generate an API secret key:
- Click Generate Secret Key.
- Copy all fields to a secure location for use in their integration.
- Click Save to lock in the new Secret Key.
WARNING
The Secret Key cannot be retrieved and is only shown after the Generate Key button is pressed. If you navigate away from this page without copying it, then it will need to be regenerated.
If you generate a new Secret Key and click Save, you will have to update all existing integrations using the AroFlo API. This means accessing them and updating their API link to AroFlo with the new details.
Troubleshooting Authentication Failure
A common issue is forgetting to click Save after copying the Secret Key. This can result in the following error when accessing the API:
Authentication Failed - AroFlo API setup is invalid. If you receive this error, you forgot to Save after copying the Secret Key.
Refer to our API documentation using the link on the page.
AroFlo API Documentation
All API Documentation is maintained at https://apidocs.aroflo.com/, which includes a collection of example calls that can be imported directly into PostMan.
We cannot offer coding support for our API in any language. We do, however, offer support for testing your queries in Postman. If you are having an issue with the API but cannot replicate the issue in Postman, then there is an issue with your code. If you can replicate the issue in Postman, please send us the details so we can investigate further.