API CYNOD

Ce document a pour objectif de présenter les API exposées par l’application CYNOD pour la gestion des fonctionnalités internes mais aussi de celles pour la mise en place de services à valeur ajouté de nos clients via les partenaires.

Vue d'ensemble

<schéma de présentation des différents composantes et de leurs interactions via API> todo

Sécurité

La sécurité de l’interface est principalement basée sur l’authentification oAuth2 combinée au protocole https qui est le canal de communication par défaut des échanges. D’autres outils internes pourront être mis en place pour renforcer la sécurité tels que le filtrage d’adresse IP, les autorisations de ports et le VPN.

Identification

Les informations suivantes sont mises à la disposition des partenaires autorisés à envoyer des requêtes:

consumer-key

consumer-secret

Ces informations permettront aux partenaires de pouvoir s’authentifier.

Authentification

L’authentification est gérée via le protocole oAuth2.

Une fois connectés via l’API d’authentification, vous aurez un access_token qui vous permettra d’accéder aux autres ressources. Les accès se feront en https.

Pour les partenaires qui le désirent, l'authentification peut être réalisée en Basic Authentication que nous ne recommandons pas.

Principe général des échanges

Le format général des APIs respecte les principes ci-dessous :

Les données échangées sont au format JSON.

La gestion des erreurs se base sur les codes statuts http, et un code d’erreur interne selon les principe ci-dessous :

En cas de succès

En cas d'erreur fonctionnelle liée à la requête du client

En cas d'erreur d'authentification

En cas d'erreur système lié à un problème serveur

Base Core API

3rd Party API

Cette section référence les API CYNOD qui sont mises à la disposition des partenaires pour construire des services digitaux au service de tous.

Principe général des échanges