API Reference

General

Iopole APIs are designed around REST architecture.

For reasons of availability and efficiency, both energetic and technical, Iopole APIs adopt an asynchronous model as much as possible.

All APIs calls must be encrypted using TLS protocol (HTTPS), all requests not encrypted will systematically failed.

Iopole offers an open sandbox system that allows you to test the solution independently with your own data sets, without affecting production data.

Information

Create your own sandbox, generate invoices in various formats and validate them here

This documentation follows version numbers corresponding to our swagger API documentation. Changes to one will result in changes to the other.

Our swagger API documentation is available here : https://api.ppd.iopole.fr//v1/api

---

Asynchronicity

Most iopole API(s) that change the state of a resource are asynchronous.
All endpoint description will indicate whether its async call or not.

Warning

All success asynchronous call will return guid, you must keep it in order to know the status of the request !

---

Rate limiting

All Iopole APIs are subject to rate limiting. This means that if the number of requests from the same source IP exceeds a specified threshold within a given time interval, any additional requests will be rejected.
Rate limit is applied on TCP and HTTP layers.
Currently, only TCP is activated, HTTP will be effective in a next release.

Information

TCP rate limit is set to a maximum of 180 requests per minute.