Introduction

Bienvenue à la version 4.0s de l'API Hyfin. L'API permet aux applications tierces d'envoyer des demandes de paiement aux clients par message texte, courriel ou les deux. Une fois reçue, le client peut consulter et payer la Facture à partir de son téléphone mobile ou de tout autre appareil sans avoir à télécharger et installer une application.

Un jeton d'accès API est requis pour accéder à l'API. Veuillez visiter le Authentification Section pour obtenir et utiliser des jetons d'accès API.

Intégration

La plateforme Hyfin prend en charge plusieurs niveaux d'accès. Ci-dessous se trouvent les définitions des structures commerciales disponibles dans l'API ainsi que la manière dont elles sont liées les unes aux autres.

Structure de niveau

Le tableau suivant représente quelques exemples dans lesquels vous pouvez configurer la structure de vos sites.

Site

Une fois qu'un site est créé en utilisant l'API Hyfin et que l'identifiant du site a été attribué, vous pouvez ensuite appeler l'un des points de terminaison de niveau Site.

Les API de niveau du site peuvent être utilisées pour ajouter ou mettre à jour des factures dans l'application Hyfin. Lorsque le Facture est ajouté à Hyfin, une demande de paiement sera automatiquement générée et le client sera notifié par message texte, courriel ou les deux, en fonction des options de notification définies dans l'enregistrement du client.

Si le client consulte le Facture sur son appareil et que celui-ci est mis à jour, un message s'affichera pour informer le client que le Facture a été mis à jour et que la nouvelle version du Facture s'affichera automatiquement sur l'appareil du client.