LâAPI Partenaires permet Ă des logiciels partenaires ainsi que des cabinets membres de rĂ©cupĂ©rer et d'envoyer de l'information depuis/vers MyUnisoft.
Lâauthentification du partenaire/cabinet est principalement basĂ©e sur:
- une clĂ© X-Third-Party fournie par MyUnisoft (Ă fournir en en-tĂȘte HTTP pour chaque requĂȘte). C'est une clĂ©
unique
qui ne doit surtout pas ĂȘtre communiquĂ© en dehors de nos Ă©quipes techniques respectives. - une clĂ© JWT (API Token) pour 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 MyUnisoft qui s'occupent de la générer et de l'activer (cà d 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 que la clé n'a pas été activée!
đŹ Type d'accĂšs â
Notre API partenaires a deux types distincts d'accĂšs, chacun de ces accĂšs permet d'interconnecter nos solutions de maniĂšre permanente par le biais d'un jeton n'ayant pas de date d'expiration (il peut ĂȘtre nĂ©anmoins rĂ©voquĂ© par le gestionnaire du dossier/cabinet ou par nos Ă©quipes techniques).
Il vous sera nécessaire de choisir l'un des deux type d'accÚs (ou de discuter plus amplement avec nous pour vous guider vers la bonne abstraction):
đž 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 de cabinet ou firm est souvent utilisé à tort pour parler d'un schéma 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 il est nĂ©cessaire d'avoir un accĂšs cabinet. Il en va de mĂȘme pour la rĂ©cupĂ©ration des entitĂ©s qui ne sont pas liĂ©es au dossier (comme les utilisateurs et les portefeuilles).
đ 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 ?
đĄ A savoir â
La racine de notre API partenaires est la suivante: https://api.myunisoft.fr/api/v1
Lors de lâutilisation dâune route exposĂ©e il est nĂ©cessaire dâavoir lâAPI Token en Bearer token dans l'en-tĂȘte Authorization.
Il est aussi nĂ©cessaire dâajouter une 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/vat_param' \
--header 'X-Third-Party-Secret: xxx-L8vlKfjJ5y7zwFj2J49xo53V' \
--header 'Authorization: Bearer {{API_TOKEN}}'
Pour plus d'informations nous vous invitons Ă consulter les sous documentations suivantes selon la nature de votre accĂšs:
- đž Usage API avec l'accĂšs sociĂ©tĂ©
- đč Usage API avec l'accĂšs cabinet
- đ Liste des routes accessibles
- đ„ Rate limiting des routes exposĂ©es
- â ïž Gestion et comprĂ©hension des retours/codes d'erreurs
đ Documentation â
Une liste de guides qui pourront certainement vous aider dans la réalisation de l'interconnexion avec MyUnisoft.
Guides sur les API cabinets â
- Création et mise à jour d'un dossier de production
- Récupérer les utilisateurs et personnes physiques
- Récupérer les dossiers accessibles pour un utilisateur
- Récupérer les dossiers de productions (entreprises)
- Récupérer le paramétrage comptable d'un dossier de production
- Récupérer les filiales associées à une entreprise
Guides sur les API comptabilitĂ©s â
- beta MAD (MyUnisoft Accounting Data)
- Récupérer et travailler avec le plan comptable
- Récupération et/ou création d'un compte
- Gérer l'analytique d'une société (dossier)
- Récupération des données liées aux widgets et dashboards
Ecritures et mouvements â
- Import JSON, TRA+PJ, FEC, Factur-X
- Export JSON, FEC, EDI
- Attacher une piĂšce jointe Ă une Ă©criture existante
- Récupérer et créer des drapeaux (flag) sur des lignes/mouvements
- Ajout ou modification d'un commentaire sur une Ă©criture
Historique â
Les guides et API suivantes seront prochainement remplacés par MAD.
- Récupérer les exercices
- Récupérer les banques (RIBS / IBAN)
- Récupérer les TVA
- Récupérer les journaux
- Récupérer les méthodes de paiement
đ„ Contact â
Prénom - Nom | RÎle(s) | |
---|---|---|
Thierry Davoigniot | PMO | t.davoigniot@myunisoft.fr |
Thomas Gentilhomme | Lead DĂ©veloppeur API & Connecteurs | partners.tech@myunisoft.fr |