Créer un compte de service

Mis à jour le S'applique à : Tous les forfaits
Read in English

Un compte de service est un identifiant d'API qui appartient à votre instance, pas à une personne. Donnez-en un à chaque système de l'entreprise qui travaille avec Finaxis : un ERP qui envoie ses factures, un outil de rapports qui lit l'âge de vos comptes, un entrepôt de données. Il agit dans la limite des portées que vous lui donnez, continue de fonctionner quand un membre part, et vous voyez chacun de ses appels.

Avant de commencer

  • Pour créer un compte de service, vous devez avoir le rôle d'administrateur. Pour vos propres scripts, créez plutôt un identifiant d'API personnel.
  • La personne qui construit l'intégration aura besoin de la documentation de l'API, à l'adresse api.finaxis.ai/docs.

Créer le compte de service

  1. Dans le menu de gauche, cliquez sur Paramètres, puis sur API.
  2. Sous Comptes de service, cliquez sur Nouveau compte de service.
  3. Dans Nom, inscrivez le système auquel l'identifiant est destiné, par exemple Power BI. Ce nom figure dans le journal des requêtes et le journal d'activité.
  4. Sous Portées, cochez ce que l'identifiant peut lire et écrire. Donnez-lui seulement ce dont le système a besoin.
  5. Cliquez sur Créer. Si Finaxis vous demande de confirmer votre mot de passe, inscrivez-le, puis cliquez sur Confirmer.
  6. Sous Votre nouveau secret, copiez le client_id et le client_secret avec leurs boutons de copie, et conservez-les dans le système ou dans votre gestionnaire de mots de passe.
  7. Cliquez sur Je l'ai copié.
La fenêtre Nouvel identifiant dans Paramètres, API, avec le nom Power BI et les portées de lecture des clients, des factures, des paiements, du recouvrement et des indicateurs cochées.
La fenêtre Confirmez votre mot de passe, que Finaxis affiche avant de créer l'identifiant.
La fenêtre Votre nouveau secret avec les champs client_id et client_secret, chacun avec un bouton de copie, et le bouton Je l'ai copié. Les valeurs sont masquées sur cette image.

À noter : Finaxis affiche le secret une seule fois. Une fois la fenêtre fermée, personne ne peut le relire, pas même un administrateur. Si vous le perdez, faites une rotation du secret.

Le compte de service apparaît ensuite sous Comptes de service, avec son client_id, ses portées, la personne qui l'a créé, et le moment et l'adresse IP de son dernier usage.

Paramètres, API, avec le compte de service Power BI : son client_id, ses cinq portées de lecture, son secret avec sa date d'expiration, et les boutons Modifier, Révoquer et Rotation.

À noter : Bonne pratique : créez un compte de service par système, et ne partagez jamais le même entre deux systèmes. Les appels et les écritures de chaque système portent alors son propre nom dans le journal des requêtes et le journal d'activité, et vous pouvez faire une rotation ou révoquer son accès sans couper les autres.

Ce que chaque portée permet

Les écritures ne touchent jamais ce qui vient de votre logiciel comptable. Les clients, les factures et les paiements synchronisés depuis QuickBooks ou Acomba se modifient dans ce logiciel, pas par l'API.

Portée Ce que l'identifiant peut faire
customers:read Lire les clients et leurs contacts.
customers:write Créer, modifier et supprimer les clients et les contacts, sauf ceux d'un logiciel comptable.
invoices:read Lire les factures et les notes de crédit.
invoices:write Créer, modifier et supprimer les factures et les notes de crédit, sauf celles d'un logiciel comptable.
payments:read Lire les paiements.
payments:write Créer, modifier et supprimer les paiements, sauf sur les factures d'un logiciel comptable.
collections:read Lire les notes, les ententes de paiement, les relances, les réponses et les appels.
collections:write Écrire des notes et des ententes de paiement, suspendre ou reprendre les relances d'un client.
insights:read Lire les soldes, l'âge des comptes, le risque et les totaux en retard.
users:read Lire les membres de l'instance et les invitations en attente.
users:write Inviter des utilisateurs, changer leur rôle et les retirer de l'instance.
activity_logs:read Lire le journal d'activité de l'instance.
webhooks:manage Gérer les webhooks de l'identifiant.
ai:use Utiliser les outils d'IA : un sommaire des retards, l'explication du risque d'un client, un brouillon de relance.

Pour changer plus tard le nom ou les portées, cliquez sur Modifier sur la ligne du compte de service. Le système demande ensuite un nouveau jeton d'accès pour profiter des nouvelles portées.

Utiliser le compte de service

Le système échange le client_id et le secret contre un jeton d'accès, valide une heure, puis appelle l'API à l'adresse https://api.finaxis.ai. La documentation de l'API décrit chaque appel, avec des exemples dans plusieurs langages, et suit l'API à chaque version : api.finaxis.ai/docs. Elle est en anglais.

La documentation de l'API Finaxis, en anglais, à l'adresse api.finaxis.ai/docs, avec ses sections à gauche : authentification, clients, factures, paiements, recouvrement, indicateurs, lots, utilisateurs, journal d'activité et webhooks.
  • Chaque fiche renvoyée porte un lien vers sa page dans Finaxis.
  • Ce qu'un compte de service écrit est identifié API – Power BI dans le journal d'activité et sur la fiche du client, avec le nom que vous lui avez donné.
  • Les clients, les factures et les paiements créés par l'API ont l'origine API, et votre équipe peut les modifier dans Finaxis comme ceux saisis à la main.

Dépannage

Situation Quoi faire
Il n'y a pas d'entrée API dans les Paramètres Vous n'avez pas le rôle d'administrateur, que les comptes de service exigent. Demandez à un administrateur, ou créez un identifiant personnel pour vos propres scripts.
Vous avez perdu le secret Faites une rotation du secret. Le nouveau s'affiche une seule fois.
L'API refuse le client_id et le secret Le secret a expiré ou a été remplacé, ou le compte de service a été révoqué. Vérifiez la liste Secrets sur sa ligne.
L'API refuse un appel faute de droits Ajoutez la portée qui manque avec Modifier, puis demandez un nouveau jeton d'accès.

Besoin d'aide avec votre intégration? Écrivez à support@finaxis.ai avec l'identifiant de requête de l'appel, et notre équipe vous aidera.

Articles liés

Vous ne trouvez pas ce que vous cherchez?

Notre équipe de soutien est là pour vous aider.