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.
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 ;
- i-Suite Expert doit être à jour dans sa dernière version ;
- les services web doivent être installés et à jour dans leur dernière version.
Pour établir une connexion avec un éditeur tiers, vous devrez lui fournir :
- Une adresse de connexion (URL i-Suite)
- Un identifiant de connexion (Login / Mot de passe)
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
Il existe deux types de connexions à l’API ACD : les connexions Cabinet et les connexions Entreprise.
Connexion Cabinet
La connexion Cabinet est destinée aux collaborateurs d’un cabinet utilisant les solutions ACD.
Elle permet d’accéder, selon les droits attribués au compte utilisé, à plusieurs dossiers clients du cabinet ainsi qu’aux différentes données disponibles via les API.
Ce mode de connexion est adapté lorsque l’interconnexion est mise en place et utilisée directement par le cabinet pour accéder aux données de ses dossiers clients.
Nous recommandons d’activer la sécurisation des comptes API afin d’empêcher les collaborateurs standards d’établir une connexion via l’API.
Le cabinet peut ainsi créer des comptes API dédiés à chaque éditeur, auxquels peuvent être associés des droits fonctionnels spécifiques ainsi que des droits d’accès aux dossiers adaptés.
Pour plus d’informations concernant la gestion des comptes API et leur configuration, vous pouvez consulter notre documentation dédiée.
Connexion Entreprise
La connexion Entreprise est destinée à une entreprise cliente d’un cabinet.
Elle utilise les identifiants associés à son accès i-Suite / Portail Client et permet d’accéder uniquement aux données du dossier de cette entreprise, dans la limite des fonctionnalités et droits qui lui sont ouverts.
Ce mode de connexion est adapté lorsque l’interconnexion est mise en place directement par l’entreprise, cliente du cabinet, pour accéder aux données de son propre dossier.
Paramétrage des rubriques de classement comptable dans la GED
Afin de récupérer via l’API les rubriques de classement des documents rattachés à une écriture comptable (factures d’achat, factures de vente, autres documents), il est nécessaire d’effectuer les paramétrages suivants 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 au niveau du cabinet (obligatoire)
Définir un plan de classement pour les journaux de type Achats et Ventes.
Ce paramétrage doit être effectué pour l’ensemble des cabinets.
Pour cela, accéder au menu Fichier - Cabinet, puis sélectionner le cabinet concerné puis cliquer sur Paramètres.
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 dans l'onglet GedExpert.
Documentation technique à destination des développeurs
Cette documentation s’adresse aux personnes disposant de compétences techniques en développement et en utilisation d’API.
La documentation technique des API ACD présente les principes d’authentification, les différentes routes API disponibles ainsi que les informations nécessaires à leur utilisation et à leur intégration.