Préambule
myCertif fournit une API Rest (acceptant et renvoyant du JSON).
Toutes les routes nécessitent d'être connecté (à l'exception des routes /api/login et /api/token/refresh). L'accès au swagger nécessite d'être connecté à votre compte.
Connexion
Vous pouvez récupérer vos identifiants de connexion via le menu au sein de la rubrique “Accès à l'API”.
Pour obtenir votre clé API, vous devez actionner le bouton “Générer”. La clé API s'affichera.
Cette clé ne s'affichera plus par mesure de sécurité. Pensez à la mémoriser sous peine de devoir la réinitialiser.
Pour obtenir une nouvelle clé API, vous devez actionner le bouton “Régénérer”. Attention, la précédente sera désactivée.
Tous les appels à l'API doivent se faire en étant authentifié. Pour cela il vous faut obtenir un token JWT puis passer ce token dans un header à chaque requête. Une fois vos identifiants récupérés vous devez solliciter la méthode : POST /api/login afin de vous connecter muni des identifiants précédemment récupérés.
La route POST /api/login vous permet d'obtenir un JWT token. Vous devez soumettre dans le body un document JSON de la forme :
{
"username": "{identifiant}",
"password": "{clé API}"
}
Si le couple username / password est correct l'api vous renverra :
{
"token:": "{jwtToken}", // Token à utiliser pour s'authentifier
"refresh_token": "{refreshToken}" // Peut être utilisé avec la route /api/token/refresh pour obtenir un nouveau token JWT.
}
Notez que le token est conçu pour expirer au bout d'une heure. Vous pouvez alors solliciter la méthode POST /api/token/refresh en y renseignant le token expiré pour en générer un nouveau. L'intérêt du refresh token est qu'on n'a pas besoin de connaître le couple username / password pour renouveler le token. Le refresh token lui a une expiration beaucoup plus grande.
Une fois le token JWT obtenu il vous suffit d'ajouter un header Authorization avec pour valeur "Bearer {jwtToken}" à vos requêtes.
Pour vous authentifier sur la documentation api, vous pouvez cliquer sur le bouton "Authorize" et saisir dans la modale "{jwtToken}".
Détails d'une route API
Vous pouvez retrouver le détail des informations à fournir dans la partie "Schema" d'une route API
