API REST
Recevez et envoyez des API REST et créez vos propres intégrations – longtemps
Réception des API REST
Fonctionnement des schémas de données et des points de terminaison
Introduction
Dans cet épisode, nous expliquerons les concepts clés sur les types d'appels REST qu'eramba peut recevoir à partir de points d'extrémité distants.
Authentification
Vous devez créer un compte dans eramba et activer la bascule "API REST", les groupes et les paramètres de visualisation appliqués à ce compte limiteront le type de données que vous pouvez voir et le type de requêtes que vous serez autorisé à effectuer. Veuillez consulter le cours "Gestion des accès" pour plus de détails.
Les appels REST qui parviennent à eramba doivent utiliser une authentification de base et s'exécuter sur TLS.
Vous devrez également créer un groupe (système / paramètres / groupes) appelé “Documentation API” (ou le nom de votre choix) et activer l’élément “Documentation API” dans la section que vous prévoyez d’utiliser des API. Cela rendra la documentation Swagger disponible pour votre compte.
Toute la documentation de l’API est gérée par swagger et vous la trouverez dans chaque section où les API sont activées dans la barre de menu supérieure sous le nom “API”.
fanfaronnade
L'accès à Swagger s'ouvrira sur un nouvel onglet avec l'interface swagger qui contient :
- méthodes disponibles
- terminaux disponibles
- simulation (récupérer uniquement les requêtes)
- définitions de schéma pour tous les points de terminaison
Tout développeur pourra comprendre le schéma et les appels basés sur cette documentation, vous pouvez également tester les requêtes (uniquement GET) à l’aide de l’interface. Il est probable que vos développeurs auront besoin de l’aide de quelqu’un qui comprend le fonctionnement d’eramba et ses modules interagissent les uns avec les autres.
Pagination et limite
Vous pouvez transmettre à votre requête les arguments suivants pour contrôler la pagination et les limites :
?page=$pageNumber&limit=$élémentsParPage
Il n'y a pas de tri disponible à ce stade.
Modifier (correctif)
Si vous souhaitez modifier un élément, le JSON doit contenir tous les champs de l'élément, pas seulement celui que vous souhaitez modifier. Pour cette raison, vous devez d'abord afficher l'élément (et obtenir tous les champs), puis l'utiliser pour effectuer le correctif (en ne modifiant que le champ que vous souhaitez mettre à jour et en laissant le reste tel quel)
Statut, commentaires et pièces jointes
Si vous souhaitez extraire un état d'élément ou des commentaires/pièces jointes, vous devez appeler un point de terminaison distinct où l'élément/la section que vous souhaitez interroger est transmis en tant que paramètre.
Si vous voulez voir les valeurs de statut (par exemple) d’un risque, vous devez cliquer sur :
