Types de connexion
Les API ACD permettent plusieurs modes de connexion selon le type d’utilisateur ou d’intégration. Chaque connexion est associée à un type d’identité permettant d’identifier l’origine de la session.
| Type | Login utilisé | Description |
|---|---|---|
| AccesApiCabinet | Code du compte API | Ce type de connexion est utilisé pour les interconnexions techniques avec les API ACD. Il repose sur le même périmètre fonctionnel qu’un compte collaborateur, mais utilise un compte dédié aux accès API afin de distinguer les appels automatisés des connexions utilisateurs. Cela permet d’identifier plus facilement l’origine des appels et de sécuriser les intégrations applicatives. |
| Collaborateur | Code du collaborateur | Cette connexion permet à un collaborateur du cabinet de travailler sur un portefeuille de dossiers, dans le cadre des restrictions d’accès définies par le cabinet. Tous les documents de la GED sont accessibles, ainsi que les dossiers publiés sur i-Suite Expert en comptabilité. |
| Client | Code du dossier | Cette connexion permet de travailler sur un seul dossier ouvert sur i-Suite Expert par le cabinet. Elle donne accès aux documents diffusables via la GED ainsi qu’aux modules i-Suite Expert activés pour ce dossier. |
| Utilisateur | Email de l’utilisateur i-Suite Expert | Cette connexion permet de travailler sur les dossiers ouverts sur i-Suite Expert par le cabinet ou depuis i-Admin. Elle donne accès aux documents diffusables via la GED ainsi qu’aux modules i-Suite Expert activés par le cabinet ou accessibles via i-Admin. |
Recommandation :
Pour les intégrations avec les API ACD, il est recommandé d’utiliser un compte de type AccesApiCabinet afin d’isoler les accès techniques des comptes collaborateurs utilisés par les utilisateurs du cabinet.
POST /v1/authentification
Ce ENDPOINT est le 1er à utiliser afin de récupérer un jeton UUID qu'il sera nécessaire d'envoyer dans les autres requêtes.
Lors de la connexion à l’API Suite Expert, l’environnement est automatiquement positionné sur un dossier. Le code de ce dossier est précisé dans la réponse de l’API, au sein de l’objet VariablesSession, dans le champ VariablesSession.ADR_ID.
L'ensemble des endpoints de comptabilité s'effectueront sur ce dossier. Il vous est possible de changer de dossier depuis l'endpoint POST V2/sessions/dossier.
En-tête
Il est possible d’utiliser l’en-tête X-CLIENT-IP pour spécifier l’adresse IP du client final, notamment lorsque la requête est émise par un serveur intermédiaire.
Si cet en-tête est utilisé lors de l’authentification, il devra impérativement être présent dans toutes les requêtes suivantes.
Détail des éléments reçus de l'API
| Champ JSON | Description |
|---|---|
| UUID | Jeton d’authentification unique utilisé pour sécuriser les appels aux endpoints de l’API. |
| Identite.Type | Type de profil utilisé pour se connecter : AccesApiCabinet, Collaborateur, Client ou Utilisateur |
| Identite.Code | Code unique d’identification de l'utilisateur dans la base ACD. |
| Identite.Email | Adresse email de l'utilisateur connecté. |
| Identite.Prenom | Prénom de l’utilisateur connecté |
| Identite.Nom | Nom de l’utilisateur connecté |
| OptionsWeb[].Option | Code technique de module i-Suite activé pour le dossier en cours |
| OptionsWeb[].Libelle | Nom lisible du module i-Suite activé pour le dossier en cours |
| OptionsWeb[].Valeur | Statut du module (toujours true si affichée ici). |
| VariablesSession.ADR_ID | Identifiant du dossier en cours dans la base ACD |
| VariablesSession.ADR_CODE | Code du dossier en cours dans la base ACD |
| VariablesSession.DOSSCOMPTA | Code du dossier comptable en cours dans la base ACD. |
| VariablesSession.CABCOMPTA | Code du cabinet de rattachement du dossier en cours |
| VariablesSession.SESSION_TIMEOUT | Durée de validité de la session en minutes du jeton UUID |