Comment utiliser l'API BCdiploma

Prérequis

1. La mise en œuvre des interfaces décrites dans le présent document ne sera possible qu'après la configuration d'un premier modèle (template) dans l'environnement de staging ou de production;
2. L'émetteur doit récupérer sa clé d'API et son ID d'émetteur dans le backoffice en tant qu'administrateur qui seront utilisés lors des appels API.
3. Le format attendu pour les dates est le format ISO YYYY-MM-DD.

Généralités sur l'API

Pour la plupart des appels REST, l'authentification est obligatoire.

L'authentification est faite par une clé d'API, qui doit être définie dans l'entête de chaque appel.

Entête HTTP obligatoire :

Authorization: Bearer <your API key>

Pour récupérer votre clé d'API et votre ID d'émetteur, consulter cet article.

Les points de terminaison des API sont les suivants :

• Recette : https://api-staging.bcdiploma.com
• Production (les données sont localisées en zone EU, par défaut) : https://api.bcdiploma.com
• Production (les données sont localisées en zone US, à la demande) : https://api-cus.bcdiploma.com

Ces points de terminaison sont notés [API-URL] dans la documentation qui suit.

Limites d'utilisation

Les API de BCdiploma sont utilisables quel que soit le plan que vous avez souscrit.

Sur les les points de terminaison [API-URL]

Deux types de limites s'appliquent simultanément :

• Limite soutenue (steady) : nombre maximum de requêtes autorisées sur une fenêtre glissante de 60 secondes.
• Limite de rafale (burst) : nombre maximum de requêtes autorisées sur une fenêtre glissante de 5 secondes, pour absorber les pics ponctuels.

Sur les les points de terminaison [TOOLBOX-URL]