Introduction
API (Application Programming Interface ou Interface de Programmation d'Application en français) est un outil permettant à 2 programmes de dialoguer entre eux.
Il s'agit d'un usage plus avancé qui peut permettre à vos clients ou partenaires de lire des données de votre système et de vous envoyer les leurs sans interventions manuelles.
Nous utilisons également les API dans les cas où vous souhaitez architecturer votre projet en plusieurs applications distinctes. Par exemple un backoffice et une application mobile, ce qui peut avoir du sens si vous avez plusieurs équipes ou plusieurs prestataires.
Comment mettre en place une API ?
La mise en place de votre API va dépendre de vos besoins.
Voici une liste de questions à se poser pour structurer votre API
- Qui doit avoir accès ?
- Quelles sont les données disponibles ?
- Quelles actions autorisons-nous sur ces données ?
API publique ou privée ?
Une API publique est disponible à l'ensemble des personnes qui y accèdent.
C'est le cas par exemple des API ouverte du gouvernement.
Généralement les API publiques sont en lecture seule !
À l'opposé, vous pouvez avoir besoin de contrôler les accès à votre API avec un système d'authentification pour sécuriser votre système. Dans ce cas, nous parlons d'une API privée.
Nous devrons mettre en place un système de connexion dans le même principe qu'un écran de connexion.
API en lecture ou en écriture
Lorsque l'objectif est de mettre en place une API pour que vos utilisateurs puissent récupérer des informations de votre système, nous parlons d'API de lecture.
Si vous souhaitez permettre à vos utilisateurs de créer, mettre à jour ou même supprimer des données, nous parlons d'API avec des droits d'écriture.
Pour chaque cas, il faudra préciser la liste des données concernées. En effet, nous pouvons permettre l'écriture sur une partie des champs seulement alors que la lecture vous donne accès à plus de données.
Droits d'accès dans votre API
Dans le cas d'une API où nous avons authentifié l'utilisateur, il est tout à fait possible d'enrichir les fonctionnalités en intégrant des droits d'accès comme nous pouvons le faire sur les écrans de nos logiciels.
- réduire le nombre d'actions disponibles
- réduire les données renvoyées
- et même aller plus loin en réduisant les champs accessibles dans une action
Comme souvent, les possibilités sont multiples et nous prendrons le temps de bien étudier votre besoin pour ne développer que ce qui vous sera réellement utile !
Notre outil de génération d'API
Comme dans tout projet, la clé du succès réside dans une bonne communication et la facilité d'utilisation.
C'est pour cela que nous avons intégré à notre plateforme un outil nous permettant de générer une documentation d'API au format Swagger.
Cette interface nous permet de rendre la documentation de vos APIs très simple d'utilisation et parfaitement claire pour faciliter leur utilisation.
En complément, l'outil vous permet de tester en direct l'API grâce à une interface ergonomique.