如何在 webhook 中添加查询号码
要使用 Advanced Integrated Visibility 追踪号码订阅 API 将追踪号码添加至您的 Webhook 订阅,请执行以下步骤:
- 使用上一节提供的步骤或入门指南中提供的步骤创建 Advanced Integrated Visibility 查询号码订阅项目。
- 您需要 OAuth 令牌才能调用 Advanced Integrated Visibility 查询号码订阅 API。可使用 Authorization API 生成 OAUTH 令牌。有关生成 OAUTH 令牌的详细步骤,请参阅 API 目录中的 Authorization API 文档。
- 单击左侧导航菜单中的“项目详细信息”选项。在“生产密钥”选项卡下,向下滚动找到 Advanced Integrated Visibility 查询号码订阅 API 说明文件。
进入 Advanced Integrated Visibility 查询号码订阅 API 说明文件后,您会发现三个端点:
Track Number Association 端点
- 使用此端点可添加或删除给定 Webhook 订阅的查询号码。请参阅 Advanced Integrated Visibility 查询号码订阅 API 说明文件,了解更多详情。
- 任何查询号码的添加或删除都属于异步工作。工作 ID 将作为添加或删除 Tracking Number Association API 调用的响应发送。
Track Number Job Details 端点
此端点提供给定工作 ID 的详细信息,例如在所有已提交的查询号码中,有多少已成功添加到给定的 Webhook 订阅中,或有多少仍在处理中。
Track Number Job Status 端点
通过此端点,您可以获得正在处理的所有工作的当前摘要。
- 使用在第 2 步中生成的 AUTH 令牌和 Track Number Association 端点,将查询号码添加到 Webhook 订阅中。
验证规则:
- Webhook 名称应唯一。
- Webhook 目的地 URL 必须符合标准化的语法格式。
- 创建 Webhook 所需的全部必填字段不能为空。
- 应关联至少一个可用的 FedEx 托运账号,才能创建 Webhook。
- 若验证成功:
- 当 Webhook 创建成功后,客户将收到确认消息。
示例确认消息:<<Webhook name>> 已成功创建。更改可能需要最多 10 分钟才能生效。
- 当 Webhook 创建成功后,客户将收到确认消息。
- 若验证不成功/失败:
- 如果 FedEx 收到的响应不是 200 (OK) 或 202 (Accepted),则 Webhook 目的地 URL 的验证将被视为失败。
Response