Advanced Integrated Visibility 的运作原理
Advanced Integrated Visibility Webhook 允许 FedEx 将安全、近乎实时的查询更新发送至指定 URL。这些更新针对与一个或多个 FedEx 账号关联的货件。要使用此功能,您需要创建一个 Advanced Integrated Visibility Webhook 项目。
如何访问 Advanced Integrated Visibility 页面
您可以通过两种方式进入 Advanced Integrated Visibility 设置页面:
方式一:通过“我的项目”
1. 导航至左侧导航面板中的我的项目。
2. 点击 Webhook 选项卡。
3. 选择 +创建 Webhook 项目。
方式二:通过 API 目录
1. 从左侧导航面板打开 API 目录。
2. 搜索 Advanced Integrated Visibility。
3. 使用 Webhook 筛选器找到对应的卡片。
4. 在卡片上:
- 点击概述,然后点击文档按钮,并选择 +创建 Webhook 项目。
- 或者前往文档,然后点击 +创建 Webhook 项目。
第 1 步:选择公司类型
点击 + 创建项目,然后从下拉列表中选择您的公司类型:
1. 使用 FedEx 进行托运,并需要将 FedEx Webhook 集成至其系统。
2. 出售或提供的软件解决方案使用 FedEx 数据,但并不是经过认证的 FedEx 兼容供应商。
3. 是经过认证的 FedEx 兼容供应商。
然后,选择 Advanced Integrated Visibility 追踪号码订阅作为订阅类型。
创建 Advanced Integrated Visibility 追踪号码订阅
您可以设置一个 Advanced Integrated Visibility 追踪号码订阅,以接收一个或多个 FedEx 追踪号码的安全、近乎实时的查询更新。这些更新将发送至您指定的目标 URL。
创建订阅的步骤
此过程包含四个主要步骤:
1. 配置项目
2. 输入项目详情
3. 确认详情并接受条款
4. 添加追踪号码
分步说明
1. 在“配置 Webhook”页面:
检查账单账号
您组织的默认账单账号将显示在此处。
如需更改:
- 点击将账单账户添加到您的组织(如果您只有一个账户),或者
- 点击选择其他账单账户(如果您有多个账户)。
注意:有关定价详情,请访问 Advanced Integrated Visibility 概述页面。
2. 选择功能
- 选择您需要的功能。
- 点击下一步继续。
提示:如需进一步了解各项功能,请点击其旁边的帮助图标 (?)。
功能描述
| 字段名称 | 说明 |
|---|---|
| 递送证明 | 确认货件已成功送达。包括:
|
| 预计送达时间 | 通过提供以下信息帮助收件人进行计划:
|
| 查询事件 | 允许选择一个或多个事件类别以接收通知:
|
在输入详细信息页面,提供以下信息:
| 字段名称 | 说明 |
|---|---|
| Webhook 项目名称 | 为您的 Webhook 项目指定一个唯一的、非空的名称。系统会自动填充一个建议名称,但您可以进行编辑。此名称不可与任何其他 Webhook 重复。 |
| 目的地URL | FedEx 用于发送查询事件数据的安全 HTTPS 端点。 要求:
|
| 安全令牌 | 用于通过 HMAC 对 Webhook 响应进行身份验证和认证的共享密钥。 要求:
|
| 负载语言(国家/地区) | 从下拉列表中选择查询数据翻译的首选语言。 |
| 追踪类型 | 选择查询数据的投递方式:
|
| 电子邮件地址 | 提供一个有效的电子邮件地址以接收通知。 |
| 电子邮件语言(国家/地区) | 选择电子邮件通知的首选语言。 注意:仅支持美国语言(例如 en-US、es-US)。 |
3. 在确认详细信息页面:
- 检查您的 Webhook 项目详细信息。
- 勾选并接受条款和条件。
- 点击创建以完成 Webhook 项目设置。
4. 请求成功提交后:
- FedEx 将创建一个新的 Webhook 项目。
- 您将收到 Advanced Integrated Visibility 追踪号码订阅 API 的生产密钥。
- 您可以使用此 API 将追踪号码关联至您的项目。
如需了解详情,请参阅 Advanced Integrated Visibility 追踪号码订阅 API 说明文件页面。
如何将追踪号码添加至 Webhook
要使用 Advanced Integrated Visibility 追踪号码订阅 API 将追踪号码添加至您的 Webhook 订阅,请按以下步骤操作:
分步操作流程
1. 创建订阅项目
· 使用上一部分中的步骤,或参考入门指南。
2. 生成 OAuth 令牌
- 您需要 OAuth 令牌才能进行 API 调用。
- 使用授权 API 生成令牌。
- 有关详细步骤,请参阅 API 目录中的授权 API 文档。
3. 访问 API 文档
- 在左侧导航菜单中,点击项目详情。
- 在生产密钥选项卡下,滚动找到 Advanced Integrated Visibility 追踪号码订阅 API 说明文件。
API 端点概述
| 端点 | 用途 |
|---|---|
| 追踪号码关联 | 在 Webhook 订阅中添加或移除追踪号码。这是一项非同步工作。响应中会返回工作 ID。 |
| 追踪号码工作详情 | 提供特定工作 ID 的详细信息,例如成功添加或仍在处理中的追踪号码数量。 |
| 追踪号码工作状态 | 返回当前正在处理的所有工作的摘要信息。 |
使用第 2 步中获取的 OAuth 令牌,通过追踪号码关联端点将追踪号码添加至您的 Webhook。
验证规则
- Webhook 名称必须唯一。
- 目标 URL 必须遵循标准语法格式。
- 所有必填字段均须填写。
- 至少需要关联一个有效的 FedEx 托运账号。
验证结果
| 状态 | 详细信息 |
|---|---|
| 成功 | 将显示确认消息: “<> 已成功创建。更改最多可能需要 10 分钟才能生效。” |
| 失败 | 如果 FedEx 收到的响应不是 200(成功)或 202(已接受),则 Webhook 目标 URL 的验证将被视为失败。 |
Response