Utilisation de l’API

Guide du débutant

news
mocoriba-api
Auteur·rice

Corentin Barbu

Date de publication

15 février 2025

Une authentification en deux étapes

Notre API est sécurisé par une authentification en deux étapes : * Basic-Auth pour laquelle il faut entrer un login et un mot de passe (qui permet aussi d’accéder aux versions partenaires de Viz). * un token qui permet d’utiliser l’API et qui est utilisé par l’API pour permettre l’accès à certaines fonctions et pas à d’autres

Les deux authentifications sont nécessaires pour pouvoir utiliser l’API.

Utilisation du Swagger

Pour faciliter l’utilisation de l’API, nous avons mis en place un “Swagger”, outil d’OpenAPI qui permet d’essayer des fonctions de l’API sur une application web. Il est disponible sur https://mocoriba.fr/mocoribaAPI/__docs__/.

Vu du haut de page du Swagger

Vous devez d’abord entrer les login et mot de passe qui vous ont été fournis.

Ensuite, il faut déverouiller l’utilisation des fonctions avec l’aide du bouton “Authorize” qui ouvre la fenêtre suivante :

Entrée du token d’identification

Dans laquelle vous entrez token et cliquez sur “Authorize”.

Vous pouvez ensuite essayer les fonctions, sans oublier de cliquer sur le bouton “Try it Out” avant d’entrer des paramètres :

Fonction de test de l’API dans le Swagger

Utilisation de l’API

Quel que soit l’outil que vous utilisez ensuite pour mobiliser l’API, n’oubliez pas de remplir à la fois l’API et le token, tel que montré dans le Swagger.