API - 概述

Lengow API使数据交换 在Lengow和您的后台办公室之间(可以是您自己的后台办公室,或者像Prestashop,Magento等软件)。 

不同的"端点"填充了API:

  • /orders/

检索所有您的订单 来自您在Lengow中设置的任何市场

  • /orders/actions/
管理并更新您的订单 (接受订单,确认发货,取消…) 根据市场的可接受订单状态列表。
  • /marketplaces/
查看所有市场有效的订单状态,以及您可以对订单进行的有效操作。
这里无法进行操作。

以下是我们的约定。这些约定是为了帮助您构建您的API请求和操作。

执行请求 / HTTP响应代码

Lengow API为每个请求提供HTTP响应代码,这些代码与用户尝试的主体和操作相对应。

以下是Lengow API最常用的响应代码:

  • 代码200:OK = HTTP 200 OK成功状态响应代码表示请求已成功。
  • 代码201:已创建 = 请求已得到满足,已创建新资源。
  • 代码202:已接受 = 请求已被接受进行处理,但处理尚未完成。
  • 代码400:错误请求 = 服务器无法或不会处理请求,因为明显的客户端错误(验证,错误的资源URL等)。
  • 代码401:未授权访问 = 当需要身份验证并且失败或尚未提供时使用。
  • 代码403:禁止 = 请求有效,但服务器拒绝操作。没有使用资源的权限。
  • 代码404:未找到 = 找不到请求的资源,但将来可能可用。
  • 代码429:请求限制已达到 = 在过短的时间内已经做了太多的请求。
  • 代码530:逻辑错误 = 请求可能由于错误的输入参数(不存在的目录,无效的搜索规则等)而失败。查看附带的消息以获取更多信息。
  • 代码540:技术错误 = 请求由于内部错误而失败。查看附带的消息以获取更多信息。
有关更多信息,请参阅HTTP代码状态列表

内容类型和接受头

"接受"头指定您想要接收的请求的格式。

相反,"内容类型"头定义了呼叫者发送到API的格式。根据 端点,Lengow API支持一组不同的消息格式。

如果您想要更改返回的数据格式,您可以设置接受 头。服务器将以给定的格式回答您,并 更改内容类型头。

  • 默认情况下,格式为“application/json”。

要获取所有接受的格式,您可以使用选项 方法,如下所示:

/orders/

转到选项 > 头

键: 接受:application/json"

将键更改为请求的格式。

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

图片来源:Postman

日期和时间字段

日期和时间字段以ISO-8601标准 表示,截至秒,偏离UTC。

用于Lengow API的日期和时间格式如下所示 (我们的示例是JSON,可能在其他编程语言中有所不同。请参阅您的语言文档以获取更多信息)。

格式:yyyy-MM-dd'T'HH:mm:ssXXX

示例日期/时间输出:

{
"marketplace_order_date": "2019-03-22T17:54:34.369000Z"
}

价格,货币和国家

  • 所有货币金额,如价格,都以十进制数字指定。

示例:5.50

  • 所有货币都以三个字符指定,按照ISO 4217 约定。

示例:EUR

  • 根据资源,国家以两个或三个字符指定,按照ISO 3166-2 约定。

示例:FR

执行请求 / HTTP方法

支持的HTTP方法:

  • GET
从API检索数据
示例:找到Lengow状态为"等待发货"的订单列表
  • POST
添加新数据。POST方法将数据发送到服务器。
示例:根据请求主体中的信息创建新的发货操作,返回一个响应主体,该主体将在创建后指向创建的发货
  • PUT:替换现有数据
  • PATCH:更新一些现有数据字段
  • DELETE:删除现有数据
0c35aff0-3f8e-410d-a64c-eb217de90202.jpg

图片来源:Postman

自动HTTPS重定向

HTTP服务的关闭,以支持HTTPS
作为我们平台安全性持续改进的一部分,以确保您的数据安全,HTTP流量自动重定向到HTTPS协议将不再可用 2022年9月1日起。

如果您不采取行动,服务中断将会发生,而我们的支持团队将无法解决问题。

如何保持我们服务的可用性?

为了确保您的工具能够使用我们的服务,我们建议您检查并更新您的设置。
根据您的组织和行动范围,您的技术部门可能需要应用这些更改。

我在哪里检查这些信息?

这取决于您如何使用Lengow平台。

  • 如果您有工具来监控您的订单,导入目录或将任何其他信息导入ERP:

检查这些工具的设置。如果您的工具设置指示URL http://api.lengow.io/...,您只需要将"http"替换为"https"(https://api.lengow.io/...)并保存修改。

  • 如果您在一个或多个频道上设置了Lengow短URL:

要继续将您的目录导出到频道,请检查每个频道上保存的设置。如果指示的设置使用HTTP协议(http://feeds.lengow.io/3/...),请更改URL以使用HTTPS协议(https://feeds.lengow.io/3/...)

验证更改后,您可以检查更新的服务是否正常工作。

本文已自动翻译。如有疑问,请参阅英文或法文原文。

此组别内的文章

我们的客服时间
欧洲中部时间周一至周五上午 9:00 至 12:30,下午 2:00 至 6:30