OpenAir provides OpenAir XML API as a layer for the exchange of OpenAir data between the main site and peripheral programs. These programs include partnered Web sites, OpenAir in-house applications that do not need direct database access, and third-party applications indirectly supported through OpenAir.
OpenAir XML APIs are used by many customers who need to create, modify, read, or delete multiple records on a single API call.
It is possible that within the XML API calls administrators reach the API limits.
Here are some tips for to further enhance its use:
Tracking Usage Level
The API limits are set on the number of requests within the current 24-hour/1-min period. This is a useful reference to track your usage level when using the OpenAir SOAP API and XML API.
It is a useful reference to track your usage level when using the OpenAir SOAP API and XML API.
This is for reference purposes only; account administrators cannot change these settings. API requests limits that are currently set for the account and the number of requests remaining within the current 24-hour period.
Navigate to: Administration >Global settings > Account > API limits to know what limits are set on account.
There might be a scenario when user would like to pull up more than 15,000 records. Aside from doing this batch by batch since there is a limitation of 1000 records to be returned to every request is a great starter.
Monitor the minute or 24-hour limit windows
The 24-hour rate limit works as a sliding window so it is not a limit for 24 hours as a calendar day, but for past 24 hours.
There are probably a few more things to highlight and mainly the API Limits. Based on the batch size selected, it might be good to also monitor the minute or 24-hour limit windows (via Administration > Global Settings > Account > API Limits or remaining limit XML API command.
Checking the Response Size
Another thing to consider is the request or the response size which might be particularly helpful when dealing with Attachments.
Since e.g. uploading 1000 attachments with a large response or even the request (dozens or hundreds of MBs) would definitely not be recommended and most likely end up with time outs, so smaller batches would be recommended (getting one record of the selected entity might give you an idea of how big the request/response pair would be).
Sequential Processing of Requests
Map the OpenAir internal ID if you want the import to update OpenAir records only. OpenAir assigns a unique internal ID sequentially to each new record.
The sequential processing of requests, which includes going one batch by another one and avoiding parallel requests at the same time especially on the same entity.
Usage of Integration Manager
Using Integration Manager helps in sequencing by itself and as a bonus, it doesn't count towards the API limits (which might be problematic if there are lot of different entities with large number of items processed).
The server-side lookup offers a little less flexibility in the type of fields that can be used as import keys. However, it is faster and more robust than the alternative client-side method.
Do you know any other useful tips related to the XML API limits? Feel free to share it with the Community!
