概述
Advanced Integrated Visibility Webhook 使 FedEx 能够将与一个或多个 FedEx 账号关联的货件查询事件数据,近乎实时且安全地推送至指定的目标 URL。您可以通过 FedEx Developer Portal 创建一个 Webhook 项目来访问此功能。
导航路径
您可以通过以下任一方式访问 Webhook 创建页面:
1. 通过“我的项目”:
- 左侧导航面板 → Webhook 选项卡 → + 创建 Webhook 项目
2. 通过 API 目录:
左侧导航面板 → API 目录
搜索或按 Advanced Integrated Visibility 筛选
选择:
- 概述 → 点击文档 → 在沙盒控制台中,点击“+ 创建项目”
- 文档 → 点击 + 创建 Webhook
Webhook 创建步骤
第 1 步:选择公司类型
点击 + 创建项目,然后从下拉列表中选择您的公司类型:
1. 使用 FedEx 进行托运,并需要将 FedEx Webhook 集成至其系统。
2. 出售或提供的软件解决方案使用 FedEx 数据,但并不是经过认证的 FedEx 电商兼容供应商。
3. 是经过认证的 FedEx 电商兼容供应商。
注意:目前 FedEx Advanced Integrated Visibility Webhook 解决方案不适用于此选项。作为 FedEx Compatible 计划的成员,如果您想访问 Basic Integrated Visibility 或其他 FedEx 集成解决方案,请联系您的渠道经理。如果您不知道渠道经理是谁,请联系您的公司管理员。
然后,选择 Advanced Integrated Visibility 账号订阅作为订阅类型。
创建 Advanced Integrated Visibility 账号订阅
创建过程包含四个关键步骤:
第 1 步:启用 Advanced Integrated Visibility 账号订阅
此步骤由 FedEx 管理员或 FedEx 代表根据第三方客户的请求进行管理。
- MNDA 文件:FedEx 管理员或 FedEx 代表将收集双方保密协议 (MNDA) 以及第一方/寄件人账号的批量列表。
注意:在此次上传过程中,允许包含已关联至其他组织的重复账号。
- 如适用,自定义定价将在组织级别启用。
注意:此功能不包含在 7 月体验中。
第 2 步:+ 创建项目
在选择产品页面上:
1. 点击 Advanced Integrated Visibility – 账号,然后点击下一步。
2. 选择账单账户,接受付款条款,然后点击下一步。
至少需要添加一个账单账户。
3. 在确认详细信息页面:
- 检查项目信息。
- 接受条款和条件。
- 如果适用自定义定价,相关文件将自动显示。
4. 创建成功后,将出现一条确认消息:
“您已成功将产品添加至‘我的项目’。”
5. 项目概览 – API 密钥激活流程
- 在项目概览页面 API 区域中的 API 密钥选项卡下,订阅的生产状态最初将显示为“已禁用”。
- FedEx 管理员或代表将根据请求启用该产品。
- 启用后,生产密钥选项卡将变为可用,生产状态将更新为“待确认”。
- 在 FedEx 管理员或代表最终激活后,生产状态将显示为“已启用”。
第 3 步:项目概览 – 配置 Webhook
1. 导航至项目概览页面。
2. 选择 Webhook 选项卡。
3. 点击 + 配置 Webhook 按钮开始配置 Webhook,即可跳转至 Webhook 选项卡
功能描述
| 字段名称 | 说明 |
|---|---|
| 递送证明 | 确认货件已成功送达。包括:
|
| 预计送达时间 | 通过提供以下信息帮助收件人进行计划:
|
| 查询事件 | 允许选择一个或多个事件类别以接收通知:
|
| 基于事件的筛选 | 筛选 Webhook 响应以包括以下货件:
|
2. 在“输入详细信息”页面,提供以下信息:
| 字段名称 | 说明 |
|---|---|
| Webhook 项目名称 | 为您的 Webhook 项目指定一个唯一的、非空的名称。系统会自动填充一个建议名称,但您可以进行编辑。此名称不可与任何其他 Webhook 重复。 |
| 目的地URL | FedEx 用于发送查询事件数据的安全 HTTPS 端点。 要求:
|
| 安全令牌 | 用于通过 HMAC 对 Webhook 响应进行身份验证和认证的共享密钥。 要求:
|
| 负载语言(国家/地区) | 从下拉列表中选择查询数据翻译的首选语言。 |
| 追踪类型 | 选择查询数据的投递方式:
|
| 电子邮件地址 | 提供一个有效的电子邮件地址以接收通知。 |
| 电子邮件语言(国家/地区) | 选择电子邮件通知的首选语言。 注意:仅支持美国语言(例如 en-US、es-US)。 |
第 3 步:选择托运账户
在选择托运账户页面:
- 选择一个或多个 FedEx 账号以关联至您的 Webhook 项目。
重要事项:
- 仅显示尚未关联至其他 Webhook 的账户。
- 您必须关联至少一个账户才能继续。
- 通过 Webhook 用户界面最多可添加 100 个账户。
- 如需关联 100 个以上账户,请使用 Webhook API。
请联系 FedEx 客户服务或帮助台申请 API 访问权限。
第 4 步:确认详细信息并创建
在确认详细信息页面:
1. 检查您为 Webhook 项目输入的所有信息。
2. 勾选复选框以接受条款和条件。
3. 点击创建以完成 Webhook 设置。
成功提交后,Webhook 将被创建,并附带一个系统生成的订阅 ID,其状态将设置为已激活。
验证规则
一般要求:
- Webhook 名称必须唯一。
- 目标 URL 必须遵循标准语法格式(使用安全的 HTTPS 协议,不得包含 fedex.com 或其子域名)。
- 所有必填字段均须填写完整,不可留空。
- 至少需要将一个有效的 FedEx 托运账号关联至该 Webhook。
验证成功:
若 Webhook 创建成功,客户将收到一条确认消息:
<<Webhook 名称>>已成功创建。更改可能需要最多 10 分钟才能生效。
验证不成功/失败:
如果 FedEx 从目标 URL 接收到的响应不是 HTTP 200(成功)或 202(已接受),则该 Webhook 的验证将被视为失败。
Response