Quels sont les différents scopes disponibles dans l’API Inqom et à quoi servent-ils ?

Cet article détaille la liste complète des scopes utilisables avec les API Inqom, leur rôle respectif et les cas d’usage associés.

🔐 Qu’est-ce qu’un “scope” OAuth2 ?

Un scope définit le périmètre d’accès autorisé lors de la génération d’un access token via l’authentification Inqom. Chaque scope correspond à un groupe de ressources ou d’API protégées.

Lorsque votre application appelle https://auth.inqom.com/identity/connect/token, vous devez indiquer un ou plusieurs scopes séparés par un espace.

Exemple :

scope=openid apidata

📜 Liste des scopes disponibles

openid : scope standard OpenID Connect. Permet l’émission d’un token JWT valide et identifiable. ✅ Requis pour tous les appels.

email : ajout l’adresse e-mail de l’utilisateur authentifié dans l’id_token. Optionnel (pour les flows utilisateurs, SSO, connexion via interface).

apidata : autorise l’accès aux API métiers principales : dossiers, écritures, plans comptables, journaux, tiers, etc. ✅ Requis pour interagir avec les données comptables (ex : import/export FEC, synchronisation Power BI, intégration ERP).

accountingdocumentsapi : permet d’utiliser l’API Accounting Documents (pièces justificatives, factures, notes de frais, GED). Optionnel (ex : applications gérant les documents ou la facture électronique).

offline_access : autorise le serveur à délivrer un refresh token (renouvellement du token sans réauthentification). Optionnel (applications web nécessitant une session persistante comme connecteurs SSO et intégrations longues durées).

🧩 Exemples concrets de combinaisons de scopes

Intégration machine-to-machine (ex. : import FEC automatique) : un logiciel de gestion envoie des écritures et pièces vers Inqom sans interaction humaine.

scope=openid apidata
Intégration outil de reporting : un client souhaite interroger les données comptables d’un dossier Inqom.
scope=openid apidata offline_access

Connecteur SSO/App front utilisateur : un partenaire ou une plateforme SaaS souhaite afficher un bouton “Se connecter à Inqom” et ouvrir le compte Inqom de l’utilisateur.

scope=openid email offline_access apidata

Application gérant les pièces justificatives : une externe importe les factures et notes de frais dans la GED d’Inqom.

scope=openid apidata accountingdocumentsapi

Intégration mixte (ERP+GED) : un ERP connecté à Inqom qui gère à la fois les écritures et les pièces justificatives.

scope=openid apidata accountingdocumentsapi offline_access

 

💡À retenir : les scopes doivent être envoyés dans le corps du POST au format x-www-form-urlencoded. 

Les environnements recette et production utilisent les mêmes scopes, seuls les endpoints changent :

  • Recette : https://auth-staging.inqom.com/identity/connect/token

  • Production : https://auth.inqom.com/identity/connect/token