Documentation API
Le contrat d'interface
Les différents registres disponibles sur l’application RNDTS sont accessibles via une API exposée pour les usages suivants :
- Création d’une déclaration ;
- Modification d’une déclaration ;
- Consultation d’une déclaration ;
- Consultation de plusieurs déclaration
L’accès à l’API est sécurisé et nécessite un jeton d’accès pour pouvoir utiliser les services.
Un "contrat d'interface" précise les droits, les obligations et les responsabilités de chaque partie en ce qui concerne l'utilisation, la maintenance et l'évolution de l'API.
C'est accord légal entre les parties qui définissent et utilisent l'interface
Le swagger
Pour pouvoir comprendre une API, il faut en comprendre la structure et les fonctions. C’est ce que permet le Swagger : un format de description libre qui aide à consigner les différentes capacités d’une API.
Avec Swagger, même les personnes qui n’ont pas directement pris part au processus de développement peuvent préparer une API permettant l'interfaçage avec la base de données de RNDTS