L'API Lengow permet l'échange de données entre Lengow et votre back office (cela peut être votre propre back office, ou un logiciel comme Prestashop, Magento etc si vous utilisez notre module).

Plusieurs "endpoints" sont disponibles dans l'API Lengow:

Récupérez le listing de toutes vos commandes ou une commande en particulier pour n'importe quelle place de marché que vous avez paramétrée avec Lengow

Gérez et mettez à jour vos commandes (accepter la commande, confirmer l'expédition, annuler…).

Visualisez tous les statuts de commande valides et toutes les actions possibles que vous pouvez effectuer sur une commande pour chaque marketplace. C'est aussi à cet endroit que vous pouvez savoir si la marketplace impose une liste de transporteurs. (Consultez nos cas d'usages pour en savoir plus!)
Aucune action n'est possible ici.

Retrouvez ci-dessous les différents paramètres d'affichage de vos données. Ces paramètres sont là pour vous aider à créer vos requêtes et actions dans l'API Lengow.

Codes de réponse HTTP

L'API Lengow fournit des codes de réponse HTTP pour chaque requête qui correspondent aux paramètres appelés et à l'action que l'utilisateur a tenté.

Voici les codes de réponse les plus couramment utilisés par l'API Lengow:

  • Code 200: OK = Le code de réponse d'état de réussite HTTP 200 OK indique que la demande a réussi.
  • Code 201: Created = La demande a été satisfaite, une nouvelle ressource a été créée.
  • Code 202: Accepted = La demande a été acceptée pour le traitement, mais le traitement n'est pas terminé.
  • Code 400: Bad request = Le serveur ne peut pas ou ne traitera pas la demande en raison d'une erreur apparente du client (validation, URL de ressource incorrecte, etc.).
  • Code 401: Access not granted = Utilisé lorsque l'authentification est requise et a échoué ou n'a pas encore été fournie.
  • Code 403: Forbidden = La demande était valide, mais le serveur refuse l'action. Aucune autorisation d'utiliser la ressource.
  • Code 404: Not Found = La ressource demandée n'a pas pu être trouvée mais pourrait être disponible à l'avenir.
  • Code 429: Request limitation reached = Trop de demandes ont été effectuées dans un laps de temps trop court.
  • Code 530: Logical Error = La requête a échoué probablement en raison de mauvais paramètres d'entrée (catalogue qui n'existe pas, règles de recherche invalides…). Voir le message d'accompagnement pour plus d'informations.
  • Code 540: Technical Error = La demande a échoué en raison d'une erreur interne. Voir le message d'accompagnement pour plus d'informations.
Plus d'information sur les code d'erreurs ici.

Paramètres de format des données

Le paramètre "Accept" spécifie le format de la demande que vous souhaitez recevoir.

Le paramètre "Content-Type" définit le format que vous envoyez à l'API. En fonction de l'endpoint sur lequel vous êtes, l'API Lengow prend en charge un ensemble de formats différents de message.

Si vous souhaitez modifier le format des données renvoyées par l'API (exemple : afficher les retours API en XML), vous pouvez définir le paramètre "Accept". Le serveur vous répondra avec le format donné et modifiera le paramètre "Content-Type".

  • Par défaut, le format est «application/json».

Pour obtenir tous les formats acceptés, vous pouvez utiliser la méthode OPTIONS comme ci-dessous:

/orders/

go to OPTIONS > headers

Key: Accept: application/json"

  • Changez la clé (key) avec le format demandé.

7444a46d-970a-4b42-86de-e0f774bbe052.png

source image : Postman

Paramètres de date et d'heure

Les champs de date et d'heure sont présentés dans la norme ISO-8601 tronqués en secondes avec un décalage par rapport à UTC.

Le format de date et d'heure utilisé pour l'API Lengow est répertorié ci-dessous (notre exemple est en JSON et peut varier dans d'autres langages de programmation. Veuillez consulter la documentation de votre langage pour plus d'informations).

Format: yyyy-MM-dd'T'HH:mm:ssXXX

Prix, devises et pays

  • Tous les montants monétaires tels que les prix sont indiqués sous forme de nombre décimal.

Exemple: 5.50

  • Toutes les devises sont spécifiées avec trois caractères, conformément à la convention ISO 4217.

Exemple : EUR

  • Selon la ressource, les pays sont spécifiés avec deux ou trois caractères, conformément à la convention ISO 3166-2.

Exemple: FR

Méthodes HTTP

Méthodes HTTP prises en charge:
  • GET
Récupérer des données de l'API.
Exemple: Récupérer les liste des commandes qui sont au statut Lengow "waiting shipment".
  • POST
Créer une action. La méthode POST envoie des données au serveur. Il faut respecter le format de requête demandé par l'API
Exemple: créer une nouvelle action d'expédition basée sur les informations que renvoie l'API etc..
  • PUT: Remplacer une donnée existente
  • PATCH: Mettre à jour certains champs de données existants
  • DELETE: Supprimer les données existantes
0c35aff0-3f8e-410d-a64c-eb217de90202.jpg

source image : Postman

Redirection HTTPS automatique

Arrêt des services HTTP au profit de l’HTTPS
Dans le cadre de l’amélioration continue de la sécurité au sein de notre plateforme et garantir la sécurité de vos données, la redirection automatique des flux HTTP vers le protocole HTTPS ne sera plus disponible à compter du 1er Septembre 2022.

Sans action de votre part, des coupures de services auront lieu sans que nos équipes Support ne puissent agir sur la résolution du problème.

Comment préserver la disponibilité à nos services ?

Pour garantir la disponibilité à nos services depuis de vos outils, nous vous recommandons de vérifier et mettre à jour vos paramètres. 

En fonction de l’organisation de votre structure et de votre périmètre d’action, l’intervention d’une personne d’un service technique ou avec des privilèges élevés peut-être nécessaire pour l’application des modifications.

Où dois-je vérifier cette information ?

Tout dépend des usages que vous avez de la plateforme Lengow.

  • Si vous avez des outils pour monitorer vos commandes, importer des catalogues ou toute autre information vers un ERP :

Vérifiez le paramétrage de ces outils. Si le paramétrage de votre outil indique une URL http://api.lengow.io/…, vous devez seulement remplacer le “http” par “https” (https://api.lengow.io/…) et enregistrer la modification.

  • Si vous avez paramétré des URLs courtes Lengow sur un ou plusieurs diffuseurs :

Pour continuer d’exporter vos catalogues sur les diffuseurs, vérifiez le paramétrage enregistré sur chacun d’eux. Si le paramétrage indiqué utitlise le protocole HTTP (http://feeds.lengow.io/3/…), modifiez l’URL pour utiliser le protocole HTTPS (https://feeds.lengow.io/3/…)

  • Si vous utilisez le tracking Lengow :

Vérifiez le code source qui est intégré à votre site marchand et forcez le protocole à utiliser en ajoutant https: à la source cible (src="//trk.lgw.io/... -> src="https://trk.lgw.io/…)

Les différents cas d’usage sont disponibles dans les les paramètre de votre compagnie.

Après avoir validé vos modifications, vous pouvez vérifier le bon fonctionnement du service mis à jour.

API / Vue d'ensemble

L'API Lengow permet l'échange de données entre Lengow et votre back office (cela peut être votre propre back office, ou un logiciel comme Prestashop, Magento etc si vous utilisez notre module).

Plusieurs "endpoints" sont disponibles dans l'API Lengow:

Récupérez le listing de toutes vos commandes ou une commande en particulier pour n'importe quelle place de marché que vous avez paramétrée avec Lengow

Gérez et mettez à jour vos commandes (accepter la commande, confirmer l'expédition, annuler…).

Visualisez tous les statuts de commande valides et toutes les actions possibles que vous pouvez effectuer sur une commande pour chaque marketplace. C'est aussi à cet endroit que vous pouvez savoir si la marketplace impose une liste de transporteurs. (Consultez nos cas d'usages pour en savoir plus!)
Aucune action n'est possible ici.

Retrouvez ci-dessous les différents paramètres d'affichage de vos données. Ces paramètres sont là pour vous aider à créer vos requêtes et actions dans l'API Lengow.

Codes de réponse HTTP

L'API Lengow fournit des codes de réponse HTTP pour chaque requête qui correspondent aux paramètres appelés et à l'action que l'utilisateur a tenté.

Voici les codes de réponse les plus couramment utilisés par l'API Lengow:

  • Code 200: OK = Le code de réponse d'état de réussite HTTP 200 OK indique que la demande a réussi.
  • Code 201: Created = La demande a été satisfaite, une nouvelle ressource a été créée.
  • Code 202: Accepted = La demande a été acceptée pour le traitement, mais le traitement n'est pas terminé.
  • Code 400: Bad request = Le serveur ne peut pas ou ne traitera pas la demande en raison d'une erreur apparente du client (validation, URL de ressource incorrecte, etc.).
  • Code 401: Access not granted = Utilisé lorsque l'authentification est requise et a échoué ou n'a pas encore été fournie.
  • Code 403: Forbidden = La demande était valide, mais le serveur refuse l'action. Aucune autorisation d'utiliser la ressource.
  • Code 404: Not Found = La ressource demandée n'a pas pu être trouvée mais pourrait être disponible à l'avenir.
  • Code 429: Request limitation reached = Trop de demandes ont été effectuées dans un laps de temps trop court.
  • Code 530: Logical Error = La requête a échoué probablement en raison de mauvais paramètres d'entrée (catalogue qui n'existe pas, règles de recherche invalides…). Voir le message d'accompagnement pour plus d'informations.
  • Code 540: Technical Error = La demande a échoué en raison d'une erreur interne. Voir le message d'accompagnement pour plus d'informations.
Plus d'information sur les code d'erreurs ici.

Paramètres de format des données

Le paramètre "Accept" spécifie le format de la demande que vous souhaitez recevoir.

Le paramètre "Content-Type" définit le format que vous envoyez à l'API. En fonction de l'endpoint sur lequel vous êtes, l'API Lengow prend en charge un ensemble de formats différents de message.

Si vous souhaitez modifier le format des données renvoyées par l'API (exemple : afficher les retours API en XML), vous pouvez définir le paramètre "Accept". Le serveur vous répondra avec le format donné et modifiera le paramètre "Content-Type".

  • Par défaut, le format est «application/json».

Pour obtenir tous les formats acceptés, vous pouvez utiliser la méthode OPTIONS comme ci-dessous:

/orders/

go to OPTIONS > headers

Key: Accept: application/json"

  • Changez la clé (key) avec le format demandé.

7444a46d-970a-4b42-86de-e0f774bbe052.png

source image : Postman

Paramètres de date et d'heure

Les champs de date et d'heure sont présentés dans la norme ISO-8601 tronqués en secondes avec un décalage par rapport à UTC.

Le format de date et d'heure utilisé pour l'API Lengow est répertorié ci-dessous (notre exemple est en JSON et peut varier dans d'autres langages de programmation. Veuillez consulter la documentation de votre langage pour plus d'informations).

Format: yyyy-MM-dd'T'HH:mm:ssXXX

Prix, devises et pays

  • Tous les montants monétaires tels que les prix sont indiqués sous forme de nombre décimal.

Exemple: 5.50

  • Toutes les devises sont spécifiées avec trois caractères, conformément à la convention ISO 4217.

Exemple : EUR

  • Selon la ressource, les pays sont spécifiés avec deux ou trois caractères, conformément à la convention ISO 3166-2.

Exemple: FR

Méthodes HTTP

Méthodes HTTP prises en charge:
  • GET
Récupérer des données de l'API.
Exemple: Récupérer les liste des commandes qui sont au statut Lengow "waiting shipment".
  • POST
Créer une action. La méthode POST envoie des données au serveur. Il faut respecter le format de requête demandé par l'API
Exemple: créer une nouvelle action d'expédition basée sur les informations que renvoie l'API etc..
  • PUT: Remplacer une donnée existente
  • PATCH: Mettre à jour certains champs de données existants
  • DELETE: Supprimer les données existantes
0c35aff0-3f8e-410d-a64c-eb217de90202.jpg

source image : Postman

Redirection HTTPS automatique

Arrêt des services HTTP au profit de l’HTTPS
Dans le cadre de l’amélioration continue de la sécurité au sein de notre plateforme et garantir la sécurité de vos données, la redirection automatique des flux HTTP vers le protocole HTTPS ne sera plus disponible à compter du 1er Septembre 2022.

Sans action de votre part, des coupures de services auront lieu sans que nos équipes Support ne puissent agir sur la résolution du problème.

Comment préserver la disponibilité à nos services ?

Pour garantir la disponibilité à nos services depuis de vos outils, nous vous recommandons de vérifier et mettre à jour vos paramètres. 

En fonction de l’organisation de votre structure et de votre périmètre d’action, l’intervention d’une personne d’un service technique ou avec des privilèges élevés peut-être nécessaire pour l’application des modifications.

Où dois-je vérifier cette information ?

Tout dépend des usages que vous avez de la plateforme Lengow.

  • Si vous avez des outils pour monitorer vos commandes, importer des catalogues ou toute autre information vers un ERP :

Vérifiez le paramétrage de ces outils. Si le paramétrage de votre outil indique une URL http://api.lengow.io/…, vous devez seulement remplacer le “http” par “https” (https://api.lengow.io/…) et enregistrer la modification.

  • Si vous avez paramétré des URLs courtes Lengow sur un ou plusieurs diffuseurs :

Pour continuer d’exporter vos catalogues sur les diffuseurs, vérifiez le paramétrage enregistré sur chacun d’eux. Si le paramétrage indiqué utitlise le protocole HTTP (http://feeds.lengow.io/3/…), modifiez l’URL pour utiliser le protocole HTTPS (https://feeds.lengow.io/3/…)

  • Si vous utilisez le tracking Lengow :

Vérifiez le code source qui est intégré à votre site marchand et forcez le protocole à utiliser en ajoutant https: à la source cible (src="//trk.lgw.io/... -> src="https://trk.lgw.io/…)

Les différents cas d’usage sont disponibles dans les les paramètre de votre compagnie.

Après avoir validé vos modifications, vous pouvez vérifier le bon fonctionnement du service mis à jour.

Cet article vous a-t-il été utile ?
Utilisateurs qui ont trouvé cela utile : 0 sur 0
Vous avez d’autres questions ? Envoyer une demande