Get started!
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.
For example, you could use one of our API methods to list the publications of one of your subscription groups. The call will send all the information in raw XML format (Extensible Markup Language). You can then receive this information and display pages containing the list of your publications on your website.
The Calaméo API is usable whatever the platform and programming language you are using, for it uses international standards: WSDL, SOAP et XML :
- A WSDL file describes the Calaméo API in a standard way
- SOAP is the messages transmission protocol between your apllication and the Calaméo API
- Data exchanged is in an XML format.
What do I need to use 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 by APIs, and allows you to precisely set the parameters relating to the level of access. You can thus grant one part of your application complete access to your Calaméo account, and restrict another part to simple viewing.
