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