This guide is intended for developers and advanced users and presents the possibilities offered by the Infomaniak API.

Introduction

• The Infomaniak API allows you to leverage the full potential of the Infomaniak ecosystem in your applications and using your preferred programming language.
• 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 is 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. Here are a few examples of how it can be used:

• Store data.
• Send email marketing campaigns.
• Broadcast video or audio streams.
• Order or manage products.
• … and much more!

For example, for a Mail Service: managing mailboxes, managing aliases, managing automatic replies, managing folders, etc. For kChat, post a message on a channel…

Create your first requests with the Infomaniak API

Consult the documentation available in English only to learn about the possibilities offered by the API.

Request format

The Infomaniak API is a REST API. The protocol used is HTTP, and requests and responses are encoded in JSON. Authentication is performed using the OAuth 2 protocol.

To initiate a request, use the following syntax: /{version}/{command_path}. You can omit the version, but in this case, the latest version will be applied. See all available requests with the Infomaniak API.

API response codes

When using the Infomaniak API, you may encounter various response codes. These codes 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 this documentation. 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
• Newsletter API
• Make your first request using Curl
• Make your first request using PostMan

Full list of tutorials