1000 FAQs, 500 tutorials and explanatory videos. Here, there are only solutions!
Discover the Infomaniak API
This guide presents the possibilities offered by the Infomaniak API.
โ ๏ธ The Infomaniak API is intended for developers and advanced users. No support is provided for creating requests or for getting started with this service. For additional help, contact a partner or launch a free tender โ also discover the role of the host.
Preamble
- The Infomaniak API allows you to leverage the full potential of the Infomaniak ecosystem in your applications and using the language of your choice.
- The Infomaniak API is a REST API; the protocol used is HTTP, requests and responses are encoded in JSON format; authentication is performed via the OAuth 2 protocol.
- Access to and use of the Infomaniak API are completely free.
Infomaniak API Usage Protocol
Using the API, you will be able to automate a wide range of actions and tasks on Infomaniak products and services, without having to use the product interfaces. Some examples of use:
- Store data.
- Send direct mail campaigns.
- Broadcast video or radio streams.
- Order or manage products.
- ... and much more!
For example, for a Mail Service: email box management, alias management, automatic response management, folder management, etc.
Create your first requests with the Infomaniak API
Refer to the documentation in English only on the possibilities offered by the API.
Request Format
The Infomaniak API is a REST API. The protocol used is HTTP, requests and responses are encoded in JSON. Authentication is performed via the OAuth 2 protocol.
To initiate a request, you must use the following syntax: /{version}/{command_path}
. It is possible not to specify the version, but in this case, the latest version will be applied.
Refer to all available requests with the Infomaniak API.
API Response Codes
When using the Infomaniak API, you may encounter various response codes. These codes precisely indicate the status of your request.
Refer to the complete list.
Limits & Restrictions
There is a limit of 60 requests per minute with the Infomaniak API. This limit cannot be increased.
The use of the API is restricted to the products listed in the official documentation. Regular additions of products and services are made to it.
If the product or service you are interested in is in the documentation, you can use the following requests: GET
; POST
; PATCH
; PUT
; DELETE
.
Learn More
- Generate and manage API tokens
- Infomaniak API: Documentation
- API Newsletter
- Make your first request using Curl
- Make your first request using PostMan