Get started!

Calaméo uses a very simple RESTful API.

What is an API?

API means Application Programming Interface. APIs allow programs or external websites (third-parties) to communicate with Calaméo and to exchange information. These exchanges allow developers to create practical programs or services using data from Calaméo. For example, you could make a calendar with your publications, or improve the way you use Calaméo thanks to tools or features that Calaméo doesn’t offer directly.

What do I need to access the Calaméo API?

A PREMIUM or PLATINUM account

You must have a PREMIUM or PLATINUM account to be able to use the Calaméo API. Upgrade your account to PREMIUM or PLATINUM.

An API key

Using an API key guarantees secure access to your account and data, and allows you to precisely set the parameters relating to the level of access you authorize for this key. You can thus grant one part of your application complete access to your Calaméo account, and restrict another part to simple viewing. To create an API key, click here

The Calaméo API is entirely HTTP-based

Methods to retrieve data from the Calaméo API require a GET or POST request.
Methods that deal with file uploads require a multipart/form-data POST.

This is a RESTful API

The Calaméo API attempts to conform to the design principles of Representational State Transfer (REST). Simply change the output parameter to get results in the format of your choice. The API presently supports the following data formats: XML, JSON, and serialized PHP formats.