Spécifications
Architecture de l'API
L'API que cette documentation présente est basée sur l'architecture logicielle REST (https://fr.wikipedia.org/wiki/Representational_state_transfer). Le format d'échange implémenté sur cette API est JSON (https://fr.wikipedia.org/wiki/JavaScript_Object_Notation).
En-tête HTTP Content-Type requis
Les requêtes HTTP réalisées via cette API devront posséder un en-tête de type Content-Type: application/json afin d'indiquer au serveur d'API que le body HTTP est encodé au format JSON.
Traductions
Cette API est structurée afin de permettre la transmission de contenus textuels dans différentes langues. Voici la liste des locales supportées par cette API
- Français (fr)
Domaines de l'API
Vous pouvez accéder à cette API dans plusieurs environnements (testing/production). Vous trouverez ci-dessous la liste des environnements supportés, ainsi que les URLs correspondantes :
| environnement | domaine |
|---|---|
| testing | https://api.staging.cloudspire.io |
| production | https://api.cloudspire.io |
Les identifiants d'accès entre les deux environnements sont totalement indépendants. Les données présentes sur le serveur de test sont factices, mais reproduisent le plus fidèlement possible les données de production.
Passage en production des flux
Une recette devra impérativement être réalisée sur serveurs de test avec un technicien de Cloudspire avant d'envisager un passage des flux en production.
Préfixe des URLs
Les URLs spécifiées dans cette documentation sont préfixées par @api. Afin d'obtenir l'URL exacte du service web à interroger, il suffit de remplacer @api par le domaine de l'environnement sur lequel vous réaliser vos requêtes.
Dates
Les dates devront être transmises en respectant le format ISO8601. Les dates communiquées par cette API sont basées sur le fuseau horaire Europe/Paris (UTC+1/UTC+2 (heures d'été)). Voici des exemples afin d'illustrer comment les dates devront être transmises/réceptionnées via cette API.
| Exemple de date | Traduction informatique |
|---|---|
| 19 Septembre 2016 | 2016-09-19 |
| 20 Février 2020 | 2020-02-20 |
| Le 19 Septembre 2016 à 17 heures 17 minutes et 14 secondes | 2016-09-19T17:18:14+0200 |
| Le 20 Février 2020 à 12 heures 02 minutes et 32 secondes | 2020-02-20T12:02:32+0100 |
Montants
Les montants seront communiqués sous la forme de nombres flottants, arrondis à deux décimales. Si aucune valeur décimale n'est requise, un entier sera communiqué à la place.
| Exemple de montant | Traduction informatique |
|---|---|
| 120 Euros 30 centimes | 120.30 |
| 99 Euros 0 centimes | 99 |