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 :
unique
ne doit surtout pas être communiquée en dehors de nos équipes techniques respectives.[!IMPORTANT] Ces deux clés sont nécessaires pour pouvoir utiliser les routes définies sur la documentation postman: https://docs.api.myunisoft.fr/
N’attendez pas pour rejoindre l’écosystème MyUnisoft connected riche de plus d’une centaine d’intégrations!
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 !
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.
[!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.
Voici la marche à suivre concernant l’authentification si vous êtes un partenaire: Comment s’authentifier ?
Voici la marche à suivre concernant l’authentification si vous êtes un cabinet ayant souscrit à l’offre API Cabinet: Comment s’authentifier ?
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.
$ 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 '
Pour plus de détails, nous vous invitons à consulter les sous-documentations suivantes en fonction de la nature de votre accès :
Une liste de guides qui pourront certainement vous aider dans la réalisation de l’interconnexion avec MyUnisoft.