Thiết lập webhook Advanced Integrated Visibility
Tổng quan
Webhook Advanced Integrated Visibility cho phép FedEx gửi dữ liệu bảo mật và gần như theo thời gian thực về sự kiện theo dõi đến URL đích được chỉ định cho các lô hàng liên kết với một hoặc nhiều số tài khoản FedEx. Bạn có thể tạo một dự án webhook để truy cập chức năng này thông qua FedEx Developer Portal.
Đường dẫn điều hướng
Bạn có thể truy cập trang tạo webhook thông qua một trong hai cách sau:
- Qua Dự án của tôi: Bảng điều hướng bên trái → tab Webhook → + TẠO DỰ ÁN webhook
Qua Danh mục API:
- Bảng điều hướng bên trái → Danh mục API
- Tìm kiếm hoặc lọc theo Advanced Integrated Visibility
- Tổng quan → Nhấp vào Tài liệu → Trong Bảng điều khiển sandbox, nhấp vào + TẠO DỰ ÁN
- Tài liệu → Nhấp vào + TẠO webhook
Các bước tạo webhook
Bước 1: Chọn loại hình công ty
Nhấp vào + TẠO DỰ ÁN và chọn loại hình công ty của bạn từ danh sách thả xuống:
- Vận chuyển qua FedEx và cần tích hợp webhook của FedEx vào hệ thống.
- Bán hoặc cung cấp giải pháp phần mềm sử dụng dữ liệu của FedEx và không phải là nhà cung cấp FedEx Compatible được chứng nhận.
- Là một nhà cung cấp FedEx Compatible được chứng nhận.
Lưu ý: Hiện tại, giải pháp webhook FedEx Advanced Integrated Visibility không hỗ trợ tùy chọn này. Là thành viên của chương trình FedEx Compatible, nếu bạn muốn truy cập vào Basic Integrated Visibility hoặc các giải pháp tích hợp khác của FedEx, vui lòng liên hệ với người quản lý kênh. Nếu bạn không biết ai là người quản lý kênh của mình, hãy liên hệ với quản trị viên công ty.
Tiếp theo, hãy chọn Gói thanh toán định kỳ Advanced Integrated Visibility dựa trên số tài khoản làm loại gói thanh toán định kỳ của bạn.
Tạo một Gói thanh toán định kỳ Advanced Integrated Visibility dựa trên số tài khoản
Quá trình này bao gồm bốn bước chính:
- Cấu hình dự án
- Nhập chi tiết dự án
- Chọn tài khoản vận chuyển
- Xác nhận chi tiết và chấp nhận điều khoản
Bước 1: Định cấu hình dự án
Trên trang Đặt cấu hình Webhook:
- Số tài khoản thanh toán:
- Xem lại tài khoản thanh toán mặc định.
- Cách thay đổi tài khoản:
- Nhấp vào THÊM TÀI KHOẢN THANH TOÁN VÀO TỔ CHỨC (nếu chỉ có một tài khoản), hoặc
- Nhấp vào CHỌN TÀI KHOẢN THANH TOÁN KHÁC (nếu có nhiều tài khoản).
Lưu ý: Cần có một tài khoản thanh toán tại Hoa Kỳ. Để biết chi tiết về giá, hãy tham khảo Hướng dẫn về giá trong Tổng quan về Advanced Integrated Visibility.
Lựa chọn tính năng:
- Chọn các tính năng bạn muốn kích hoạt, sau đó nhấp vào Tiếp theo.
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. Hình ảnh bằng chứng giao hàng (PPODA): Cung cấp ảnh cho thấy địa điểm giao hàng chính xác. Bằng chứng giao hàng có chữ ký (SPOD): Cung cấp hình ảnh chữ ký và tên của người nhận cùng ngày, giờ và địa điểm giao hàng. |
| Giao hàng ước tính | Giúp người nhận lập kế hoạch bằng cách cung cấp: Ngày giao hàng ước tính (EDD) Khung thời gian giao hàng ước tính (EDTW) |
| 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: Vận chuyển Đang vận chuyển Giao hàng Ngoại lệ Tùy chọn giao hàng tùy chỉnh |
| Lọc theo sự kiện | Lọc phản hồi của webhook để bao gồm: Lô hàng nhập Lô hàng xuất Lô hàng của bên thứ ba |
Trên trang Nhập chi tiết, hãy cung cấp thông tin sau:
| 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: Phải hợp lệ và đang hoạt động Phải tuân theo cú pháp chuẩn hóa Không được bao gồm fedex.com hoặc các miền phụ của miền này Có thể sử dụng lại trên nhiều webhook. Tham khảo phần Quy tắc kinh doanh và phương thức tối ưu để biết thêm chi tiết. |
| 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: 26 – 100 ký tự Phải có ít nhất 1 chữ hoa, 1 chữ thường và 1 ký tự số Có thể sử dụng lại trên nhiều webhook |
| 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: Theo dõi chi tiết – Toàn bộ lịch sử sự kiện Theo dõi sự kiện cụ thể – Chỉ sự kiện gần đây nhất |
| Đị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ữ tại Hoa Kỳ (ví dụ: en-US, es-US). |
Bước 3: Chọn tài khoản vận chuyển
Trên trang Chọn tài khoản vận chuyển:
- Chọn một hoặc nhiều số tài khoản FedEx để liên kết với dự án webhook.
Ghi chú quan trọng:
- Chỉ những tài khoản chưa liên kết với các webhook khác mới được hiển thị.
- Bạn phải liên kết ít nhất một tài khoản để tiếp tục.
- Bạn có thể thêm tối đa 100 tài khoản thông qua giao diện người dùng webhook.
- Để liên kết hơn 100 tài khoản, hãy sử dụng API webhook.
Hãy liên hệ với Bộ phận hỗ trợ khách hàng hoặc Bộ phận trợ giúp của FedEx để yêu cầu quyền truy cập API.
Bước 4: Xác nhận chi tiết và tạo
Trên trang Xác nhận chi tiết:
1. Xem lại tất cả thông tin bạn đã nhập cho dự án webhook.
2. Đánh dấu vào ô để chấp nhận các điều khoản và điều kiện.
3. Nhấp vào Tạo để hoàn tất quá trình thiết lập webhook.
Sau khi gửi thành công, webhook sẽ được tạo với ID đăng ký do hệ thống tạo và sẽ được đặt ở trạng thái Hoạt động.
Quy tắc xác thực
Yêu cầu chung:
- 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 hóa (HTTPS an toàn, không có fedex.com hoặc các miền phụ).
- Tất cả các trường bắt buộc phải được điền đầy đủ. Không được để trống bất kỳ trường bắt buộc nào.
- Phải có ít nhất một số tài khoản vận chuyển FedEx hợp lệ được liên kết với webhook.
Xác thực thành công:
Nếu webhook được tạo thành công, khách hàng sẽ nhận được thông báo xác nhận:
Đã tạo thành công <<Tên webhook>>. Các thay đổi có thể mất tối đa 10 phút mới có hiệu lực.
Xác thực Không thành công/thất bại:
Nếu FedEx nhận được bất kỳ phản hồi nào khác ngoài HTTP 200 (OK) hoặc 202 (Đã chấp nhận) từ URL đích, việc xác thực webhook sẽ được coi là thất bại.
Response