Introduction
Une API (Interface de Programmation d’Applications) est un pont qui permet à différentes applications de communiquer et de travailler ensemble de manière automatique.
ACD a développé des API pour permettre à d’autres éditeurs d’interagir avec nos logiciels. La liste de ces éditeurs utilisant nos API est disponible sur notre site web, dans la rubrique Interfaces technologiques.
Les API liées à la comptabilité nécessitent le partage du dossier sur i-Suite.
Pour établir la connexion avec un éditeur tiers, vous devrez fournir :
- L’adresse de votre serveur i-Suite (URL de base)
- Un identifiant de connexion (Login / Mot de passe)
Prérequis
Avant de procéder au paramétrage de l’accès à l’API ACD, les prérequis suivants doivent être respectés :
- Disposer d’i-Suite Expert ;
- La Suite Expert doit être à jour de sa dernière version ;
- Les services webs doivent être installés et être à jour de leur dernière version.
Adresse de connexion
Pour se connecter via l’API, il est nécessaire de récupérer l’URL de base, composée de l’adresse du serveur i-Suite et de la référence de connexion (CNX) de la base de données.
Ces informations sont indiquées dans le logiciel de Gestion, via le menu Aide → Infrastructure ACD. Une fenêtre Infrastructure s’ouvre alors directement dans le logiciel.
Il vous est ensuite possible de copier cette URL de base afin de la coller dans l’interface du logiciel tiers pour établir la connexion API.
Identifiant de connexion
La connexion API peut s’effectuer avec un profil Collaborateur, Client ou Utilisateur i-Suite.
Pour un profil Collaborateur, il est déconseillé d’utiliser les identifiants d’un véritable collaborateur pour les connexions API. Nous recommandons d’activer la sécurisation des comptes API, qui empêche un collaborateur standard d’établir une connexion via l’API. Vous pourrez ainsi gérer des accès API dédiés à chaque éditeur, en leur associant des sécurités fonctionnelles et des droits d’accès spécifiques aux dossiers.
Pour plus d’informations concernant la gestion des comptes API et leur configuration, vous pouvez consulter notre documentation dédiée.
Partage du dossier dans ACD COMPTA
Publication du dossier
Ouvrir la comptabilité du dossier. À partir du menu i-Suite Expert - Gestion du partage, le fait d’activer le partage du dossier en comptabilité permet de publier le dossier sur le serveur i-Suite Expert pour en bénéficier au niveau de l’API.
Dans l'onglet i-Comptes, activer la coche Actualisation en temps réel afin de récupérer le grand livre et la balance par API en temps réel.
Paramétrage des rubriques de classement dans la GED
Afin de récupérer via l’API les rubriques de classement des documents rattachés à une écriture (factures d’achat, factures de vente, autres), il est nécessaire d'effectuer le paramétrage suivant dans le logiciel de comptabilité.
Paramétrage multicabinets (obligatoire)
Depuis le menu Fichier - Paramétrages - GED Expert - Fonctions, définir un plan de classement générique applicable à l’ensemble des journaux de tous les dossiers de la base de données.
Rechercher le code CSAI (Saisie comptable) puis définir le plan de classement associé
Paramétrage niveau cabinet (Obligatoire)
Définir un plan de classement pour les journaux de type achats et ventes. Ce paramétrage doit être effectué sur l’ensemble des cabinets. Pour cela, aller dans le menu Fichier - Cabinet, sélectionnez le cabinet.
Dans l'onglet GEDExpert, définir le plan de classement des achats et des ventes.
Paramétrage du journal (optionnel)
Il est possible de définir une rubrique de classement spécifique pour un journal. Ce paramétrage est prioritaire sur les autres niveaux. Pour cela, aller dans le menu Fichier - Journaux, puis sélectionner le journal. Indiquer ensuite le plan de classement à partir du bouton Plan de classement saisie Panière dabs l'onglet GedExpert.
Accès au Swagger
Accès nécessitant des compétences de développeur
Le Swagger est un outil qui facilite l’interaction et la compréhension des API pour les développeurs, leur offrant à la fois un guide et un environnement de test. Les différents endpoint disponibles y sont décrits.
L’URL du swagger dépend de votre serveur i-Suite :
https://{Adresse URL i-Suite du cabinet}/{CNX du cabinet}/api/swagger/
Accès à notre documentation technique à destination des développeurs.