Authentification


Pour utiliser l'API Hyfin, vous devez être un partenaire approuvé disposant d'un jeton d'API. Pour demander un jeton, écrivez à notre équipe de soutien de l'API à l'adresse api-support@hyfin.app .


En-tête de la demande

Envoyez votre jeton d'API dans l'en-tête x-access-token de chaque requête, comme illustré ci-dessous. Remplacez API_TOKEN_VALUE par votre jeton.

x-access-token: VALEUR_JETON_API

Une requête reçue sans jeton est rejetée avec le code HTTP 401 et Unauthorized access, et une requête dont le jeton est illisible est rejetée avec le code HTTP 401 et Session expired, please sign in again.


Accès à l'API

Un jeton valide ne suffit pas à lui seul. Chaque site que vous appelez doit aussi avoir la fonctionnalité d'accès à l'API activée. Si ce n'est pas le cas, votre première requête vers ce site renvoie cette erreur :

Feature integrations.hyfin_api_access is not available for Site {site_id}

Cette erreur signifie que votre jeton et votre requête sont corrects, et que seul l'accès à l'API est manquant. Hyfin l'active pour chaque site; adressez-vous donc à votre représentant ou à l'adresse du soutien API ci-dessus.