Authentication

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 .

Request Header

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.

API Access Feature

A valid token is not on its own enough to call the API, because API access is a licensed feature that must be enabled on the site you are calling. Every site-scoped call is checked against the integrations.hyfin_api_access feature, so a site that does not have it fails on its very first request rather than part way through your integration.

Confirm the feature is enabled on the site before you begin. A site without it rejects the call with this error:

Seeing that error means the token and the request were both accepted and the feature is the only thing missing. It is enabled per site by Hyfin, so contact your representative or the API Support address above to have it turned on.