Fonctionnalités
prix
documentation
Comment utiliser ERP Connector?

Survol de l’API d’Online ERP / ERP Connector

Survol

Les connecteurs ERPConnector / OnlineERP sont des API RESTful qui permettent aux développeurs et aux entreprises d’interagir avec les systèmes ERP (comme Acomba, Avantage, Sage50, Servicentre) de manière programmatique et intégrée.  Que vous souhaitiez récupérer des données, créer des entités, ou modifier des informations, cette API offre une solution flexible et sécurisée pour intégrer vos applications avec les logiciels ERP.

Si vous voulez un survol de la solution de plus haut niveau, nous vous conseillons de lire cet article sur le fonctionnement du connecteur.

 

1.  Les bases de l’API

L’API Online ERP Connector fonctionne via des requêtes HTTP standard. Voici les verbes HTTP les plus couramment utilisés :

  • GET : Permet de récupérer des informations. Par exemple, obtenir la liste des produits, des clients, ou des commandes.
  • POST : Utilisé pour créer une nouvelle entité, comme un produit, une facture, ou un client. Un corps de requête (body) est nécessaire pour spécifier les détails de l’entité à créer.
  • PUT : Permet de mettre à jour une entité existante, comme modifier les informations d’un client ou d’un produit.
  • DELETE : Utilisé pour supprimer une entité. Attention, cette fonctionnalité peut être limitée selon les configurations de l’ERP.

Exemples de requêtes

  • GET : https://gateway.erpconnector.ca/api/Entity/Product/
    Récupère la liste des produits.
  • POST : https://gateway.erpconnector.ca/api/Entity/Product/
    Crée un nouveau produit. Un corps de requête valide est requis.
  • PUT : https://gateway.erpconnector.ca/api/Entity/Product/
    Modifie un produit existant. Un corps de requête valide est nécessaire.
  • DELETE : https://gateway.erpconnector.ca/api/Entity/Product/
    Supprime un produit. Cette fonctionnalité peut ne pas être disponible dans certains ERP.

Pour connaître la liste des entitées,  voir ici Documentation API 

 

2. Authentification

Pour accéder à l’API, vous devez disposer des informations suivantes :

  1. Code Licence : Une clé unique qui identifie votre instance de l’ERP. Chaque client possède un code licence distinct.
  2. Clé secrète : Un mot de passe ou clé d’API, qui protège l’accès à vos données. Cette clé ne doit jamais être partagée publiquement.
  3. Company Code: À partir de la version 4, ce champ identifie la compagnie spécifique à utiliser. Si omis, la valeur par défaut est vide.

Méthode d’authentification

L’API utilise l’authentification Basic Auth à partir de la version 4. Le CodeLicence sert de nom d’utilisateur, et la Clé secrète comme mot de passe. Toutes les communications se font via HTTPS, garantissant la sécurité des données transmises.

Le CompanyCode, doit être passé en HEADER,  sous le code ‘COMPANY_CODE’:VotreCompanyCode

  • Par mesure de flexibilité, et si le HEADER n’est pas possible pour vous, il est aussi possible de passer le companyCode en le mettant après un PIPE, apres le CodeLicence
    •  par exemple, votre basic auth (encodé base64) serait  :
      • CODELICENCEABCDE|COMPANYCODE:CleSecrete

Poursuivre la lecture:

pour poursuivre votre lecture, nous vous conseillons de lire :

1 – Comment rédiriger des requêtes RestFull: Composer une requête à l’API d’Online ERP / ERP Connector.

2 – La liste des entitées utilisables, le support par Système Comptable, liste des champs : Documentation API