Basics - Calaméo Knowledge Base
Not a Calaméo member yet?
Sign up now! It's FREE!
Get the latest news on Calaméo
Follow us on Facebook
Get Calaméo updates in real-time
Follow us on Twitter

Basics

From Calaméo Knowledge Base

Calaméo uses a very simple RESTful API.

<toc>

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.

Click here for more detail on API.

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

First of all, you will need a valid Calaméo account.

You can sign up here. It's free.

To access the Calaméo API, you will be required to use an API key.

Using an API key guarantees a safe access to your account and data, and allows you to set up precisely the level of access you authorize for this key.

You can thus grant complete access to one part of your application, 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.