Welcome, Partners!
Here we answer some of the common questions regarding access the Avero API to ingest raw data for our integration services. If you do not see an answer to your question below, please email support@averoinc.com or your Partner contact for assistance.
- Are there rate/query limits?
- How do I get started?
- I'm receiving a Business Not Found error, what can I do?
- Do I always need to include a Business ID when sending a request?
- How can I send a test query to know that my token works and I am set up correctly?
Are there rate/query limits?
The rate limits can be found in the specifications shared when implementing the API and are per unique IP Address. We limit calls to 300/min maximum and 5000/day maximum per unique IP to protect API performance for all partners.
How do I get started?
See our full guide here: Avero API: Getting Started
I'm receiving a Business Not Found error, what can I do?
This means that either you have an incorrect business ID, are using the wrong set of credentials for that business ID, or access to the data for that business ID has not been provisioned to your App. Regardless of the cause, email Avero support for assistance. Make sure to provide the App Name, Business Name, Business ID, and any other information relevant to your request.
Do I always need to include a Business ID when sending a request?
We have an endpoint for the retrieval of Business IDs, defining the Business ID for which you wish to query in all other endpoints is recommend (or you will receive data for all Business IDs to which you have access. This retrieval endpoint is also the ideal test endpoint to ensure your authorization and token are correctly applied.
How can I send a test query to know that my token works and I am set up correctly?
First, review the Setup & Authorization instructions below to set up your environment and request a token.
Then, go to the APIs
side panel, expand the Avero Public API
and open the top-level GET
request. Uncheck the checkbox next to Cursor
and click Send
In the results pane, you should now see data from the API response. Success!
We have an endpoint for the retrieval of Business IDs, defining the Business ID for which you wish to query in all other endpoints is recommend (or you will receive data for all Business IDs to which you have access. This retrieval endpoint is also the ideal test endpoint to ensure your authorization and token are correctly applied.
-
- Business Retrieval Endpoint URL: https://averoinc-prod.apigee.net/public-api/v1/core/businesses
- Sample response:
{
"data": [
{
"businessId": "7047",
"businessName": "Blue Cafe",
"currencyCode": "USD",
"revenueCenters": [
{
"revenueCenterId": "5123786",
"revenueCenterName": "Bar"
},
{
"revenueCenterId": "5123787",
"revenueCenterName": "Dining Room"
},
{
"revenueCenterId": "5123788",
"revenueCenterName": "Secondary Dining"
},
{
"revenueCenterId": "5123789",
"revenueCenterName": "Take Out"
},
{
"revenueCenterId": "5123790",
"revenueCenterName": "Tertiary Dining"
},
{
"revenueCenterId": "5123820",
"revenueCenterName": "Banquet"
}
]
}
],
"meta": {
"pagination": {
"next": null
}
}
}