Aller au contenu principal

S'authentifier à l'API

L'adresse de base de l'API est https://gateway.conexio.dev/api. Toute requête doit être en HTTPS et authentifiée.

La méthode : Basic Auth (depuis la version 4)​

  • Nom d'utilisateur = votre Code Licence (clé unique de votre instance).
  • Mot de passe = votre Clé API.
  • Concrètement : header Authorization: Basic base64(CodeLicence:CléAPI).

Le HUB valide la paire auprès du gestionnaire de licences : une licence inexistante, expirée ou pas encore démarrée est refusée (réponse 401).

Choisir la compagnie : header COMPANY_CODE​

Chaque requête doit porter le header COMPANY_CODE, qui désigne la compagnie visée. Il est obligatoire, même si votre licence ne couvre qu'une seule compagnie : sans lui, la requête est refusée.

Sa valeur est le code de compagnie de la fiche de connexion, par exemple DEFAULT ou PROD_01. Vous le trouvez dans le portail client, sous Gestion des connexions ERP. Ce code est du texte : ce n'est pas un numéro de compagnie.

Exemple complet​

GET https://gateway.conexio.dev/api/Entity/Customer?$top=5
Authorization: Basic {base64(CodeLicence:CléAPI)}
COMPANY_CODE: DEFAULT

Notes​

  • La clé API se définit dans le portail web de gestion des licences (nouvelles instances Conexio) ; sur les anciennes instances OnlineERP, dans le menu OPTIONS de l'agent (« Cette clé secrète, combinée au code de licence, constitue l'intégralité de votre clé d'API »).
  • Ne partagez jamais la clé API ; elle se transmet à l'intégrateur au moment de l'installation (voir la Trousse de départ).
  • 401 = code licence ou clé invalide/expirée. Vérifiez aussi que vous appelez bien https://gateway.conexio.dev/api et non une ancienne adresse (*.onlineerp.solution.quebec, obsolète).

Cette page vous a-t-elle été utile ?