Teapplix REST API V2接口

Teapplix API是REST API，支持JSON/CSV数据格式。运行在https协议基础上。

您可以使用Teapplix API来完成以下工作：

1.发货

Teapplix整合了多家物流运营商，其中包括美国国内和国际的运营商。一旦您使用Teapplix API进行集成，就可以获得Teapplix支持的所有物流运营商的邮资费率报价、和打印面单。目前Teapplix支持的物流运营商和服务有：USPS – 由Teapplix提供邮资计费，以美元和其他预先协商的货币付款，以及有优惠的USPS“蓝色”费率。

•     USPS – 由Teapplix提供邮资计费，以美元和其他预先协商的货币付款，以及有优惠的USPS“蓝色”费率。
•     USPS Presort Services - 由Teapplix和USPS合作伙伴提供。涵盖产品包括First Class Presort，Parcel Select Presort和Parcel Select Light Presort。
•     DHL eCommerce  -美国国内，国际和危险品运输服务。您可以提供自己的DHL eCommerce账户，或在特定情况下使用Teapplix提供的账户。
•     DHL Express – 由Teapplix提供邮资计费，以美元和其他预先协商的货币付款，并有折扣价格。
•     联邦快递 - 包括SmartPost和FedEx Freight。您提供自己的联邦快递帐户。
•     UPS - 包括Mail Innovations，SurePost和Freight。你使用自己的UPS账户。
•     中国邮政。

Teapplix 发货API可以获得邮费报价和生成发货面单，无论是否有订单下载到Teapplix系统。在没有订单在Teapplix系统里的情况下，您只需指定发件人、发货人地址和物流的发货方式即可，您就可以获取到订单的面单。

2.订单同步

您可以将Teapplix绑定到Teapplix支持的电商平台，然后使用Teapplix从电商平台同步订单到Teapplix

•      Teapplix可以通过您指定的URL向您发送“推送订单”。可以设置为在新订单进入Teapplix时或在有过滤订单条件下自动发生，或者在按下按钮时手动发生。
•      您可以通过推送订单接口“Order Notification”将订单推送到Teapplix。
•      您可以通过Teapplix的下载物流接口“Ship Notification”获取订单的物流运输信息。
•      您可以设置Teapplix将物流运输信息发送到您指定的URL。
•      您可以使用“Ship Notification”POST方法将非Teapplix系统的订单的物流运输信息推送到Teapplix，随后Teapplix会自动标记订单发货并回传追踪单号到电商平台。

3.库存同步

Teapplix可以管理库存数量，并可以将库存数量和价格信息同步到链接的电商平台。 借助Teapplix API，您可以：

•      将库存数量信息上传到Teapplix
  •     定期完整上传的仓库的库存数量
  •     增量“补充库存”
  •     库存调整
•      将最新的“库位”信息上传到Teapplix
•     上传“价格变化”到Teapplix
•    从Teapplix下载最新的数量信息

4.虚拟卖家帐户和嵌入Teapplix Web界面

您可以使用Teapplix API创建“虚拟卖家帐户”。创建后，您可以为特定的虚拟卖家启动特定的Teapplix用户界面页面，页面将允许他们链接到电商平台并使用其他Teapplix提供的功能。这通常适用于Teapplix的第三方合作伙伴，它可以提供一个Teapplix帐户绑定多个卖家的情况，并允许第三方将所有功能构建到他们自己的Web应用程序中。

API认证，URL终端

所有的Teapplix API调用都需要一个HTTP标头“APIToken”来进行认证。该令牌在Teapplix设置页面上获得：

转到您的Teapplix“设置=> API”页面。每个帐户只能有一个令牌，如果生成另一个新令牌，则以前的令牌将被删除并不再有效。

Teapplix API V2终端的根URL位于：

https://api.teapplix.com/api2

特定的调用将为终端添加额外的路径。请认真阅读每个文档所描述的接口。例如，“PurchaseLabel”接口地址为：

https://api.teapplix.com/api2/PurchaseLabel

HTTPS协议

Teapplix API通过HTTPS运行，目前我们仅支持TLS1.1和TLS1.2。如果您有一台非常旧的计算机，如Windows 2008 Server或Windows XP，则无法与Teapplix api.teapplix.com网关建立API连接。Teapplix在有限的时间内继续提供API端点的维护工作，以允许使用这些系统。请联系Teapplix客服以便获取解决方案。

推送端点(Notification End Points)

“推送”是从Teapplix到外部系统的Web hooks。此类推送需要“端点”，这是Teapplix将发送此类推送的外部URL。

您可以在Setup => API页面上定义URL端点。端点具有以下信息：

•     名称 - 这只是一个描述文本，可帮助您确定终点的用途
•     URL - 这是Teapplix发送推送的http，https或其他协议地址
•     认证方案 - Teapplix在呼出期间使用的认证信息。我们支持基于HTTP头的认证，或HTTP基本认证，也就是用户名+基于密码的认证。

Teapplix推送目前是无用户验证方式，不支持多身份认证方案。