API Bienvenue Formation

Droits d'accès

L'API et la documentation sont disponibles pour les utilisateurs avec le droit "Accès API". Si vous êtes administrateur, accédez au menu avec le nom de votre Organisation puis "Utilisateurs".
Utilisez l'action "Gérer les droits" pour l’utilisateur concerné (y compris vous même le cas échéant) afin de lui attribuer cet accès.

Documentation

La documentation complète est accessible à l'adresse : https://formation.bienvenue.pro/api/doc/user

Elle permet de visualiser toutes les routes disponibles, les paramètres à fournir et les réponses possibles.

Il s'agit également d'une sandbox qui permet d'effectuer des requêtes directement depuis l'interface (un véritable appel est effectué et comptabilisé).

Pour cela il faut bien penser à configurer l'authentification :

En haut à droite, cliquez sur Authorize
Rentrez votre token sous la forme Bearer votreToken
Vous pouvez ensuite utiliser toutes les routes de la sandbox

Authentification

L'authentification est de type Bearer Authentication.

Dans le profil utilisateur, il est possible d'accéder à la gestion des clés API (Accédez au menu en haut à droite avec vos initiales, puis "Mon profil" et enfin "Gérer mes clés API" en dessous de votre nom).

Vous pouvez générer autant de clés que vous le souhaitez. Chaque clé sera associée à votre compte et aura les mêmes droits que celui-ci. Il est donc conseillé de créer un compte utilisateur séparé pour l'accès à l'API.

Pour s'authentifier il faut rajouter le header suivant dans la requête :

Authorization: Bearer VotreToken

Mis à jour le : 11/09/2023