Authentification

Only authorized users can access the Hyfin APIs. In order to access the APIs, you must be an approved partner and have an API token assigned to you. To request an API Token, please email our API Support team at api-support@hyfin.app .

En-tête de la demande

Every call to the API requires an x-access-token property be added to the request headers to connect. The following is an example of the request header. Simply replace API_TOKEN_VALUE with your api access token when adding it to the request headers.

Fonctionnalité d'accès à l'API

Un jeton valide n'est pas suffisant en soi pour appeler l'API, car l'accès à l'API est une fonctionnalité sous licence qui doit être activée sur le site que vous appelez. Chaque appel à portée de site est vérifié par rapport à la fonctionnalité integrations.hyfin_api_access, donc un site qui ne l'a pas échoue dès sa toute première requête plutôt qu'en cours d'intégration.

Confirmez que la fonctionnalité est activée sur le site avant de commencer. Un site qui ne l'a pas rejette l'appel avec cette erreur :

Voir cette erreur signifie que le jeton et la demande ont tous deux été acceptés et que la fonctionnalité est la seule chose manquante. Hyfin l'active pour chaque site, alors contactez votre représentant ou l'adresse de soutien de l'API ci-dessus pour la faire activer.