希波连接器

与 Shippo 的应用程序接口集成

简介

Shippo是一个多承运商运输 API 和网络应用程序，其中包括 USPS、DHL、FedEx 等承运商。客户可以获取运费、打印标签、自动处理国际文件、跟踪货物运输情况并方便退货。

目的

该集成强调了如何利用 Tulip 的 HTTP 连接器功能与 Shippo 的 API 集成，以自动创建快件、从一系列承运商处获取各种费率、选择最佳费率、最后创建和打印快件标签以及跟踪快件的选项。所有这些都可以在您的 Tulip 应用程序中完成。根据不同的使用情况，与 Tulip 的集成可用于控制供应链运作，并实时了解包裹的运输情况。

API 文档

Shippo API 文档

前提条件

在 Shippo 网站上创建一个账户，并生成 API 标记，在调用 Shippo API 时用作授权标题。Shippo 允许您生成测试和实时令牌。测试令牌可用于与 API 进行 HTTP 调用测试，并设计您的 Tulip 应用程序，一旦应用程序准备就绪，令牌就可以切换，应用程序就可以部署到生产中，实时生成发货标签和交易。

Tulip 连接详情

Tulip 的 HTTP 连接器需要配置以下详细信息，才能与 Shippo 建立连接。

1. 运行于：云连接器主机
2. 主机：api.goshippo.com
3. 端口:443
4. TLS:Yes
5. 可通过连接器函数传递 Shippo 标记作为授权头

连接器功能

创建货件

目的

1. 该连接器函数通过向 Shippo 的 API 进行 POST 调用来创建一个新的快件，请求体包括发件人详细信息、收件人详细信息和包裹详细信息。
2. 创建成功后，Shippo 会返回一个 JSON 对象，其中包括所创建货物的状态，以及不同供应商的费率选择，用户可利用这些费率选择继续前进并启动交易。用户可以选择合适的费率，并将费率 ID 存储在 Tulip 变量中，然后动态传递到相应的连接器函数中，以创建交易并生成货运标签。

端点

1. HTTP POST 调用端点：https://api.goshippo.com:443/shipments/

授权头

为了验证 Shippo 的 API，需要在请求头中传递 Shippo 的 HTTP 标记。格式如下

授权：ShippoToken ($ShippoToken$)

所需输入

以下是在请求正文（内容类型为 JSON）中传递的输入参数。

1. 发送方名称、街道、城市、州、邮编、国家。
2. 收件人名称、街道、城市、州、邮政编码、国家/地区
3. 包裹尺寸 - 长度、宽度、宽度和重量

所需的输出提取器

创建的装运对象会返回很多信息，但需要提取的重要字段如下所示

1. 状态：表示货件是否创建成功
2. 货件 ID：可用于获取已创建货件的详细信息。
3. 费率选项：表示不同供应商提供的不同费率选项的对象数组。费率 ID 是需要提取的重要关键字，通过它可以为该货件创建实际交易。

创建交易

用途

1. 该连接函数从上一个连接函数创建新货运时返回的不同选项中选择供应商和最终费率后，创建交易。
2. 通过向 Shippo 端点进行 POST HTTP 调用，并传递与所决定的费率相关的 ID，即可建立成功的交易。调用成功后，Shippo 会返回一个 JSON 对象，其中包括交易状态、跟踪 ID、发货标签和跟踪 URL 等信息。返回的发货标签可直接从郁金香应用程序打印。

端点

1. HTTP POST 调用端点：https://api.goshippo.com:443/transactions/

授权头

为了验证 Shippo 的 API，需要在请求头中传递 Shippo 的 HTTP 令牌。格式如下

授权：ShippoToken ($ShippoToken$)

所需输入

以下是在请求正文（内容类型为 JSON）中传递的输入参数。

1. 汇率 ID：为创建成功交易，传递所选汇率的 ID。

所需的输出提取器

创建的装运对象会返回很多信息，但需要提取的重要字段如下所示

1. 状态：表示交易是否创建成功
2. 交易 ID：可用于获取已执行交易的详细信息。
3. 跟踪编号：用于跟踪货物
4. 跟踪 URL：所选供应商的跟踪页面 URL
5. 标签 URL：装运标签，可嵌入郁金香应用程序进行打印