Booxi provides powerful APIs to integrate with your ecosystem.
Depending on the chosen endpoint, use of the API may require a Merchant API key or a Partner API key.
Your Merchant API key can be found in the Back Office ("My Business" tab > Business Details).
Partner API keys are not publicly available; Booxi will provide you a key on request. To obtain one, contact your Booxi representative.
*Note: the Partner API key should be used exclusively in server-side (backend) code to ensure it remains confidential.
To access Booxi's online API documentation, select the link according to your hosting region:
Fair use
API Key usage
The Merchant API key shall be used as a public key, which can be implemented in both client and server sides. The Partner API key shall be used as a private key (similar to a password) and solely used for server to server calls. If a partner key is exposed to the public, Booxi shall not be held responsible for any data leak associated with this partner key, as it is your responsibility to protect the confidentiality of the key.
API calls
API calls per API key shall not exceed 5 requests per second with a maximum of 300 requests per minute. Exceeding this quota will return a 429 error, and it is your responsibility to respect this quota and handle the 429 errors. It is recommended to make API calls with an interval of at least 10 ms between each request. Any API calls generating 400 errors will count as double requests for the quota.
API change
Booxi will notify you at least 6 months before discontinuing any API or applying backwards-incompatible changes to any API. Booxi shall be free to apply any changes required to comply with applicable law, address a material security risk, or avoid a substantial economic or material technical burden.
API abuse
API usage is solely authorized to conduct legal business by you or a consultant under contractual agreement with you. Any usage for spam or reported as abusive is strictly prohibited and will result in the revocation of the API access. It is also prohibited to resell the use of the API.
As part of its progressive maintenance, Booxi may choose to develop new components.
Limitations
Limit of 300 calls per minute.
Polling is not permitted, the use of a webhook is recommended instead.
The API shall not be used to query large amounts of data, such as for reporting or BI purposes. The use of a webhook or automated CSV transfers is recommended instead.