Tout ce qu'il faut savoir sur l'API Lengow !
Démarrer facilement avec nos cas d'utilisation concrets et les concepts clés expliqués.
Veuillez noter que nous proposons un plugin pour se connecter à my.lengow.io que vous pouvez utiliser à la place de notre API si vous disposez d'un back-office sur Prestashop, Magento, Shopify, Shopware ou Woocommerce.
Afin de commencer à vous connecter à notre API, assurez-vous de disposer d'un compte Lengow. Cela vous permettra de vous authentifier et de vous connecter à l'API.
L'API Lengow utilise le standard REST.
Tout au long de ce guide, nous vous recommandons d'utiliser Postman pour vous aider à intégrer et tester notre API.
Lengow ne fournit pas de support sur Postman.
Concepts clés
Avant de commencer, voici quelques concepts centraux de l'API :
- A.P.I
API est un acronyme pour Applications Programming Interface. Une API est donc une interface de programmation qui permet de se « brancher » sur une application pour échanger des données.
Elle fonctionne sur un principe d’entrées et de sorties c'est à dire, qu'on l'utilise pour envoyer des actions et récupérer des informations entre deux systèmes.
Elle va aussi poser un cadre, c'est à dire, définir les types d'appels et de requêtes qui peuvent être effectués, comment les passer, et le format attendu qui doit être utilisé pour que ça fonctionne.
- Access token (jeton d'accès)
Pour vous authentifier sur l'API, vous devez obtenir un jeton d'accès (token). C'est un bloc de caractères qui contient les informations d'identification de sécurité pour une session de connexion et qui identifie l'utilisateur (vous).
Exemple de jeton: "6b7280eb-e7d4-4b94-a829-7b3853a20126
- Authorization header (En-tête d'autorisation)
L'Authorization header contient vos informations d'authentification. Une fois que vous avez votre jeton d'accès, toutes vos demandes vers l'API auront besoin d'un Authorization header.
- Endpoint
L'emplacement, le point d'entrée vers un endroit précis de l'API, on l'utilise pour y envoyer une demande, récupérer des informations et effectuer des actions.
Exemple : /orders/ est le endpoint qui amène vers le listing commandes dans l'API
- Pagination
Ce paramètre vous permet de définir sur combien de pages vous souhaitez voir s'afficher les résultats de votre requête. Et de définir combien de résultats vous souhaitez par page(s).
Lorsqu'elle n'est pas définie, la valeur par défaut de la page est 1.
Exemple : /orders/?account_id=1&page=5&page_size=50
- Paramètres de requête (filtrage)
Avec l'utilisation de paramètres de requête, les utilisateurs peuvent définir des filtres supplémentaires qui peuvent limiter le nombre d'entités renvoyées dans la réponse.
Les utilisateurs peuvent éventuellement spécifier les paramètres de la requête et les combiner à volonté. Les paramètres de requête sont ajoutés à la fin d'un chemin de ressource.
Le premier paramètre de requête est préfixé par "?", Tous les paramètres de requête supplémentaires sont séparés par le symbole "&".
Exemple : /orders/?account_id=1&marketplace=menlook
- Les produits
Un produit est tout article qui peut être envoyé depuis Lengow vers un diffuseur. Il est généralement défini par son EAN (code européen de numérotation des articles), ou par un identifiant unique que vous avez choisi et enrichi de descriptions, d'images et d'autres contenus.
- Commandes et articles de commande (orders, order items)
Lorsqu'un client achète un ou plusieurs articles sur un diffuseur, une commande est créée (order). La commande contient un ou plusieurs articles de commande (order items). Chaque article de commande contient un identifiant unique, une quantité, un prix, une référence client, etc.
- Autres concepts et flux
Un envoi est créé lorsqu'un ou plusieurs articles de commande sont envoyés au client, un retour est créé lorsqu'un client souhaite retourner un article de commande et une annulation est utilisée pour annuler une commande ou un article de commande.
Retrouvez le processus complet ici.
