#4 - API Eden ERP & CRM

Introduction

L'API d'Eden ERP est organisée selon l'architecture REST. Notre API utilise des URL orientées ressources, accepte des corps de requêtes encodées en formulaire, renvoie des réponses encodées en JSON et utilise des codes de réponse HTTP standards, ainsi que l'authentification et les verbes HTTP habituels.

Vous pouvez utiliser l'API d'Eden ERP en mode test sur un environnement de préproduction, ce qui n'affecte pas vos données de production. L'URL endpoiint vous utilisez pour la requête détermine si la requête est sur l'environnement de production ou de test.

L'API d'Eden ERP ne prend pas en charge les mises à jour en masse BULK. Vous ne pouvez travailler que sur un objet par requête.

L'API d'Eden ERP diffère pour chaque compte client car nous publions de nouvelles versions régulièrement et adaptons les fonctionnalités aux besoins spécifiques de chaque client.

Certains cas d'exemple peuvent différer. Certaines ressources/objets spécifiques à votre projet ne seront pas documentés ici mais suivent les mêmes règles que les objets standards.

Authentification

L’authentification pour utiliser l’API Eden se fait via une clé API qui vous sera fournie par votre intégrateur.

Cette clé est à passer dans le Header de la requête “X-Client-Id”

Toutes les requêtes API doivent être faite via HTTPS. Tous les appels via HTTP échoueront.

Erreurs

Eden utilise des codes de réponse HTTP conventionnels pour indiquer le succès ou l'échec d'une requête API.

En général :

• Les codes dans la plage 2xx indiquent le succès.
• Les codes dans la plage 4xx indiquent une erreur due à des informations fournies (par exemple, un paramètre requis a été omis, une valeur incorrecte a été fournie, etc.).
• Les codes dans la plage 5xx indiquent une erreur avec les serveurs de Eden (cas rares).

Versions

Lorsque des modifications incompatibles avec les versions antérieures sont apportées à l'API, une nouvelle version datée est publiée. La version actuelle est 2018-v2. Un guide sur les mises à jour de l'API pour en savoir plus sur la compatibilité ascendante sera publié avec la version v3. Pour toutes les mises à jour de l'API, consultez notre journal des modifications d'Eden ERP & CRM.

Pour définir la version de l'API lors d'une requête spécifique, spécifiez la version souhaitée dans l'url de la requête. Par précaution, utilisez le versionning de l'API pour tester une nouvelle version avant de vous engager dans une mise à niveau de vos applications.