Quelques conseils pour utiliser au mieux notre API.
La documentation de l’API
La documentation est accessible aux adresses suivantes :
backend core : https://core.fairandsmart.com/doc/api.html
backend data : https://data-fr01.fairandsmart.com/doc/api.html
backend timestamp : https://tsa.fairandsmart.com/api-doc
Authentification des accès
L’accès à l’API se fait via un bearer token obtenu via OAuth2 auprès du serveur d’authentification https://auth.fairandsmart.com/ .
Les access token ayant une durée de vie nettement plus courte que celle des refresh token (5 minutes vs. 30 jours), il est conseillé de conserver une copie de ce dernier pour éviter d’avoir à ouvrir une nouvelle session à chaque appel REST, et le renouveler uniquement si nécessaire.
Ce fonctionnement permet en outre de pouvoir modifier le mot de passe du compte utilisé pour récupérer refresh et access token de manière asynchrone, et de ne pas se couper l’accès à l’API le temps de propager le changement de production de le code de votre applicatif.
Choix d’un User ID lors de la génération d’un formulaire de consentement
Un User ID doit être passé aux appels de génération des endpoints de collecte de consentement (https://core.fairandsmart.com/doc/api.html#operation/getConsentEndointJson). Dans la mesure où cet identifiant circule en clair et/ou figure en clair dans le registre de consentements, sa définition doit présenter des garanties appropriées.
Ainsi nous recommandons d'éviter de choisir un User ID permettant d’identifier directement un utilisateur, en utilisant un pivot qui nécessite l’accès à votre SI pour être résolu.
En particulier l’utilisation des noms-prénoms, adresses email, n° SS ou même d’une version obfusquée réversible tel que l'encodage en base64 de ces attributs sont à éviter.