Cet exemple de description d'APIs est a titre d'illustration mais aussi en tant que cadre de definition des API de BCEF IT dans un but d'uniformisation et d'industrialisation.
Le format de serialisation des ressources choisi est JSon. Ce document ne respecte aucune norme particuliere de structuration du JSon (ex: JSon API)
Les API sont protegees par une authentification mutuelle TLS (mTLS) qui se materialise par la presence d'un Header specifique lors de l'appel aux differents controllers.
Toutes les API exigent certaines donnees dans le header et restituent des headers particuliers.
Terminologie/Glossaire :
-"Customer" represente la personne proprietaire des ressources manipulees (resources owner)
-"Utilisateur/User" represente la personne a l'origine de l'action. Cette donnees est presente dans le header (userId) des appels. Cette personne peut etre un collaborateur de la banque ou le Customer lui-meme.
-"Client" represente le service appelant dans une architecture Client Server.
-"Server" represente le service exposant les API decrites dans le present OAS.
-"Representation" est la materialisation de la ressource dans un format serialise.