Skip to content

How do I use the API?

Back to portal

Sometimes it is easy to make use of the API, for example, if you want some tasks to run automatically.
Or maybe you want to make use of a pre-baked webshop like WHMCS.
To make use of this, a few steps will need to be completed.

The API page can be found under "My Account" > "API".
Here you will also find the documentation of the API which can be downloaded by clicking on "Download latest version".

To get the API working the password must be changed and the IP added to the API whitelist.
The password and the specifications to which it must conform are described.
This password will only be used for an API connection and will not change the password for the my.oxxa.com account.

An IP can be added to the whitelist by clicking the "Add IP" button.
Here an IP address is requested which will communicate with the API.
In the list below added IP addresses can be discarded if desired.

Back to portal