1 – Survol
Les requêtes sont classées par domaine d’affaires :
-
Accounting: Contient des entités relatives à la comptabilité (module comptable de votre ERP).
-
Account Receivable : Contient des entités relatives au module CLIENT de votre ERP.
-
Account Payable : Contient les entitées relatives au module FOURNISSEUR de votre ERP.
-
Inventory : contient les entitées relatives au module INVENTAIRE de votre ERP
-
HR : Contiendra des entités relatives aux ressources humaines.
2 – Authentification
Pour utiliser cet API, vous devez absolument avoir trois informations qui vont permettre d’identifier à quel logiciel ERP [Acomba, Avantage, etc..] vous voulez communiquer.
-
CodeLicence : Le code licence est une clé unique permettant d’identifier le connecteur qui nous intéresse.
-
Un code licence est unique à un client.
-
-
CompanyId : Le company ID est utilisé à partir de la version 4 du connecteur. Il permet d’identifier précisément, pour UN code licence, quelle « compagnie » utiliser.
-
Un code licence peut effectivement avoir plusieurs Compagnies (ex: Compagnie Acomba, Compagnie Avantage).
- Si omit, l’API va utiliser par défaut la valeur 0.
-
-
Clé secrète : La clé secrète est un mot de passe qui protège (entre autre) vos données d’entreprise. Cette clé ne doit JAMAIS être divulguée publiquement.
À partir de la V4 vous devez absolument être authentifié via une authentification de type Basic Auth pour communiquer avec l’API ainsi que vos connecteurs. L’authentification Basic Auth utilise le code licence comme usager, et la clé secrète comme mot de passe. Cette authentification est déjà prête dans la collection Postman d’Online ERP : Liste des verbes et appels possibles pour le connecteur Acomba/Avantage OnlineERP
Vous n’avez qu’à alimenter les ‘VARIABLES’ de la collection.
Étant donnée que le traffic passe nécessairement sous https, vos données sont protégée!
3 – Versions de l’API
3.1 – Version 3 (2016 – 2023)
Cette version de l’API est désormais considérer que pour les utilisations légataires.
Elle reste toujours disponible.
La Version 3 expose les endpoints.
-
/MyTask
-
/Customer
-
/Product
3.2 – Version 4 (2023 – )
La Version 4 expose deux endpoints principaux.
Endpoint ERPConnectorTask
ERPConnectorTask est la nouvelle mouture (2024) plus flexible des tâches d’Online ERP. Le payload est très similaire au modèle de données MyTask de la V3, mais avec plusieurs améliorations et changements. Cette nouvelle mouture permettra entre autre d’unifier tous nos autres logiciels/Solutions avec un payload puissant, sécuritaire et flexible.
Cet endpoint prend comme payload POST, une tâche ErpConnectorTask, qui définira l’entité (client, produit, vendeurs, etc..), l’action à entreprendre (extract, create, modify), ainsi que d’autres informations utiles à l’exécution de votre requête.
Endpoint Entity
L’endpoint Entity est en fait une couche d’abstraction des ErpConnectorTask. Cet endpoint va en fait « composer » pour vous un ERPConnectorTask.
Cette couche d’abstraction vous permettra d’avoir une expérience d’API ultra standardisée selon le paradigme REST. Le verbe GET se traduit par une requête d’extraction de données, le verbe POST est utilisé pour la création d’une nouvelle entité et finalement Le verbe PUT vous permetera de modifié une données existante dans votre ERP.
Voici quelques exemples :
-
GET /Entity/Product
-
POST /Entity/Customer
- PUT /Entity/Supplier
- etc. …