API Partenaire

Appearance

L’API Partenaires permet aux logiciels partenaires ainsi qu'aux cabinets membres de récupérer et d'envoyer des informations depuis et vers MyUnisoft.

L’authentification du partenaire ou du cabinet est principalement basée sur :

  • une clé X-Third-Party : fournie par MyUnisoft, à inclure dans l'en-tête HTTP de chaque requête. Cette clé unique ne doit surtout pas être communiquée en dehors de nos équipes techniques respectives.
  • une clé JWT (API Token) : propre à chaque cabinet et/ou société.

IMPORTANT

Ces deux clés sont nécessaires pour pouvoir utiliser les routes définies sur la documentation postman: https://docs.api.myunisoft.fr/

👀 Prérequis ​

✏️ Les éléments et informations à fournir
  • nom partenaire.
  • description courte partenaire (3 lignes 25 char maximum).
  • description longue.
  • logo partenaire (png, hauteur 50px).
  • texte complémentaire (par exemple ou coller la clé sur votre interface ou lien vers une doc/vidéo d’utilisation avec myunisoft)
  • nom, prénom, email pour un accès à myunisoft.
  • nom, prénom, email pour une invitation slack/teams.
👉 Ce que nous renvoyons une fois les éléments ci-dessus en notre possession
  • Clé X-Third-Party (C’est une clé secrète unique entre vous et nous qui sera nécessaire pour requêter l’API).
  • Un compte au sein d'un schéma (cabinet) dédié aux tests d'intégration.
  • Lien vers la documentation postman (https://docs.api.myunisoft.fr/#intro).

N'attendez pas pour rejoindre l'écosystème MyUnisoft connected riche de plus d'une centaine d'intégrations!

Activation de la clé secrète X-Third-Party ​

Vous n'avez rien à faire pour activer cette clé. Ce sont les équipes de MyUnisoft qui s'occupent de la générer et de l'activer (c'est-à-dire la rendre valide vis-à-vis de l'API Partenaires).

NOTE

Il peut y avoir un certain délai entre la génération de la clé et son activation. La clé ne sera pas reconnue par notre API tant qu'elle n'aura pas été activée !

🔬 Type d'accès ​

Notre API partenaires propose deux types distincts d'accès. Chacun permet d'interconnecter nos solutions de manière permanente via un jeton sans date d'expiration (il peut néanmoins être révoqué par le gestionnaire du dossier/cabinet ou par nos équipes techniques).

Il vous sera nécessaire de choisir l'un des deux types d'accès (ou de discuter plus amplement avec nous pour vous guider vers la bonne option) :

🔸 Un accès restreint a une société (dossier de production) d'un cabinet.

🔹 Un accès à l'intégralité d'un cabinet.

NOTE

Le terme cabinet ou firm est souvent utilisé à tort pour désigner un schéma (ou tenant) dans MyUnisoft. Un schéma peut contenir un à plusieurs cabinets et représente un client signé sur le plan commercial et technique.

Diagramme de définition des entités

TIP

Pour récupérer la liste et le paramétrage de plusieurs dossiers, ainsi que pour accéder aux entités non liées au dossier telles que les utilisateurs et les portefeuilles, il est nécessaire d'avoir un accès de type cabinet.

(retour en haut de page)

🔐 Authentification ​

Partenaire ​

Voici la marche à suivre concernant l'authentification si vous êtes un partenaire: Comment s'authentifier ?

Formule API Cabinet (destiné aux cabinets eux-mêmes) ​

Voici la marche à suivre concernant l'authentification si vous êtes un cabinet ayant souscrit à l'offre API Cabinet: Comment s'authentifier ?

(retour en haut de page)

💡 A savoir ​

La racine de notre API partenaires est la suivante: https://api.myunisoft.fr/api/v1

Pour vérifier sa disponibilité et son bon fonctionnement vous pouvez appeler: https://api.myunisoft.fr/api/partners/health

Toutes les réponses de l'API Partenaires contiennent un ID unique afin de traquer les requêtes. Vous trouverez cet ID dans le header request-id.

TIP

N'hésitez pas à exploiter cet ID (dans vos logs par exemple). Cet info est utile lors des échanges avec le support MyUnisoft.

Lors de l’utilisation d’une route exposée, il est impératif d'inclure l’API Token en tant que Bearer token dans l'en-tête HTTP Authorization.

De plus, vous devez ajouter l'en-tête “X-Third-Party-Secret” contenant la clé secrète communiqué par notre équipe.

bash
$ curl --location
--request GET 'https://api.myunisoft.fr/api/v1/mad/exercices?version=1.0.0' \
--header 'X-Third-Party-Secret: xxx-L8vlKfjJ5y7zwFj2J49xo53V' \
--header 'Authorization: Bearer {{API_TOKEN}}'

Pour plus de détails, nous vous invitons à consulter les sous-documentations suivantes en fonction de la nature de votre accès :

📌 Documentation ​

Une liste de guides qui pourront certainement vous aider dans la réalisation de l'interconnexion avec MyUnisoft.

Guides sur les API cabinets ​

Guides sur les API comptabilités ​

Révision ​

Ecritures et mouvements ​

Documents ​

(retour en haut de page)