Cách thức hoạt động của Advanced Integrated Visibility
Tổng quan về webhook Advanced Integrated Visibility
Webhook Advanced Integrated Visibility cho phép FedEx gửi dữ liệu sự kiện theo dõi một cách an toàn và gần như theo thời gian thực đến URL đích được chỉ định cho các lô hàng liên kết với (các) số tài khoản FedEx được chỉ định.
Để sử dụng chức năng này, Quản trị viên FedEx hoặc Quản trị viên DI phải tạo một dự án webhook Advanced Integrated Visibility.
Các tùy chọn điều hướng
Bạn có thể truy cập trang Webhook Advanced Integrated Visibility theo hai cách:
Cách 1: Qua mục Dự án của tôi
- Từ bảng điều hướng bên tay trái, hãy chuyển đến mục Dự án của tôi.
- Nhấp vào tab Webhook.
Cách 2: Qua Danh mục API
- Từ bảng điều hướng ở bên tay trái, vào Danh mục API.
- Sử dụng thanh tìm kiếm để tìm Advanced Integrated Visibility hoặc chọn Advanced Integrated Visibility trong phần BỘ LỌC.
- Trên thẻ Webhook, chọn một trong những mục sau:
- Nhấp vào Tài liệu → sau đó nhấp vào + Quản lý webhook
Xem dự án Gói thanh toán định kỳ Advanced Integrated Visibility dựa trên số theo dõi
1. Quy trình thiết lập và quyền truy cập cá nhân vào FedEx
- Quản trị viên FedEx hoặc Đại diện FedEx sẽ khởi tạo quy trình thiết lập.
- Hồ sơ tổ chức được tạo bởi quản trị viên được chỉ định thay mặt cho khách hàng CSP.
- Một số tài khoản thanh toán hợp lệ tại Hoa Kỳ đã được quản trị viên thêm vào ở cấp tổ chức thay mặt cho khách hàng.
- Quản trị viên thực hiện quy trình thiết lập này phải có quyền phù hợp để quản lý các cấu hình cấp tổ chức.
2. Xem quy trình làm việc dành cho Gói thanh toán định kỳ dựa trên số theo dõi
2.1 Xem Gói thanh toán định kỳ
- Sau khi Quản trị viên hoặc Đại diện FedEx tạo dự án, người dùng có thể xem Dự án gói thanh toán định kỳ Advanced Integrated Visibility dựa trên số theo dõi có liên quan trong bảng điều khiển của họ.
2. Xem các tính năng
- Người dùng có thể khám phá các tính năng hiện có được liên kết với dự án gói thanh toán định kỳ để hiểu rõ hơn và sử dụng hiệu quả.
Mô tả tính năng
| Tên trường | Mô tả |
|---|---|
| Bằng chứng giao hàng | Xác nhận rằng lô hàng đã được giao thành công. Bao gồm:
|
| Giao hàng ước tính | Giúp người nhận lập kế hoạch bằng cách cung cấp:
|
| Sự kiện theo dõi | Cho phép chọn một hoặc nhiều danh mục sự kiện để nhận thông báo:
|
Trên trang Chi tiết, thông tin sau sẽ được hiển thị:
| Tên trường | Mô tả |
|---|---|
| Tên dự án Webhook | Tên không trùng lặp, không để trống cho dự án webhook của bạn. Tên được đề xuất sẽ tự động điền nhưng bạn có thể chỉnh sửa tên này. Bạn không được sử dụng lại tên này trong bất kỳ webhook nào khác. |
| URL đích | Điểm cuối HTTPS an toàn, nơi FedEx sẽ gửi dữ liệu về sự kiện theo dõi. Yêu cầu:
|
| Mã thông báo bảo mật | Mã bí mật dùng chung được sử dụng để xác thực và kiểm tra phản hồi của webhook thông qua HMAC. Yêu cầu:
|
| Ngôn ngữ (quốc gia) cho phần tải | Chọn ngôn ngữ ưu tiên cho bản dịch dữ liệu theo dõi trong danh sách thả xuống. |
| Loại theo dõi | Chọn cách thức cung cấp dữ liệu theo dõi:
|
| Địa chỉ email | Cung cấp địa chỉ email hợp lệ để nhận thông báo. |
| Ngôn ngữ email (Quốc gia) | Chọn ngôn ngữ ưu tiên để nhận thông báo qua email. Lưu ý: Chỉ hỗ trợ ngôn ngữ của Hoa Kỳ (ví dụ: en-US, es-US). |
Quy trình từng bước
4. Tạo Dự án gói thanh toán định kỳ
- Làm theo các bước trong phần trước hoặc tham khảo Hướng dẫn bắt đầu.
5. Tạo Mã thông báo OAuth
- Bạn cần có mã thông báo OAuth để thực hiện các lệnh gọi API.
- Sử dụng Authorization API để tạo mã thông báo.
- Vui lòng tham khảo tài liệu về Authorization API trong Danh mục API để biết các bước chi tiết.
6. Truy cập tài liệu API
- Trong menu điều hướng bên trái, nhấp vào Chi tiết dự án.
- Trong tab Mã khóa sản xuất, cuộn để tìm tài liệu về Advanced Integrated Visibility Tracking Number Subscription API.
Tổng quan về điểm cuối API
| Điểm cuối | Mục đích |
|---|---|
| Liên kết số theo dõi | Thêm hoặc xóa số theo dõi khỏi gói thanh toán định kỳ webhook. Đây là một công việc không đồng bộ. ID công việc sẽ được trả về trong phản hồi. |
| Chi tiết công việc dựa trên số theo dõi | Cung cấp thông tin chi tiết cho ID công việc cụ thể, chẳng hạn như số lượng số theo dõi đã được thêm thành công hoặc vẫn đang được xử lý. |
| Trạng thái công việc dựa trên số theo dõi | Trả về bản tóm tắt tất cả các công việc hiện đang được xử lý. |
Sử dụng mã thông báo OAuth từ Bước 2 với điểm cuối Liên kết số theo dõi để thêm số theo dõi vào webhook của bạn.
Quy tắc xác thực
- Tên webhook không được trùng lặp.
- URL đích phải tuân theo định dạng cú pháp chuẩn.
- Phải điền tất cả các trường bắt buộc.
- Phải liên kết ít nhất một số tài khoản vận chuyển FedEx hợp lệ.
Kết quả xác thực
| Trạng thái | Chi tiết |
|---|---|
| Thành công | Thông báo xác nhận sẽ hiển thị: "Đã tạo thành công <>. Các thay đổi có thể mất tối đa 10 phút mới có hiệu lực". |
| Không thành công | Nếu FedEx nhận được bất kỳ phản hồi nào khác ngoài 200 (OK) hoặc 202 (Đã chấp nhận) thì việc xác thực URL đích của webhook sẽ bị coi là thất bại. |
Response