General Guidelines
To make the most of Avionté APIs, please observe the guidelines listed below.
Error Handling Recommendations
When encountering errors, implement the following backoff strategy:
- Wait 5 seconds after the first error.
- Wait 10 seconds after the second error.
- Continue doubling the wait time until a maximum of five errors is reached.
Callback URL Limitations
Only one callback URL is supported for the Production environment and one for a Non-Production environment.
Polling Restrictions
Do not configure your integration to poll the API, as Avionté's API operates on an event-based model. Polling the system may result in the suspension of your API keys. Instead, make use of events to determine when you need to retrieve updated or changed items.
Event Handling During Outages
In case of an outage, Avionté will store events and process them once service is restored. Subscribe to the Avionté Platform Status page to stay informed about system status.
Use of Batch Endpoints
Avoid calling batch endpoints when a single call is sufficient, as this reduces the load on the Avionté API. Misuse of batch endpoints may result in throttling. Batch endpoints should ideally be used during overnight or weekend hours.
If you need to use batch endpoints during business hours, schedule a consultation meeting to review the business case before implementation.
Updated 26 days ago