Fedex Logo

Giới thiệu

Gói đăng ký Advanced Integrated Visibility dựa trên số theo dõi được thiết kế cho những người đăng ký Advanced Integrated Visibility để quản lý các dự án webhook dựa trên số theo dõi của họ và thực hiện các hoạt động liên quan đến dự án như thêm số theo dõi mới, chỉnh sửa hoặc xem thông tin chi tiết về công việc bằng điểm cuối API.

Lưu ý:

  • Bạn phải có quyền truy cập của quản trị viên hoặc cộng tác viên để quản lý dự án Advanced Integrated Visibility của mình
  • Để biết thêm thông tin về Advanced Integrated Visibility cùng các tính năng, hãy truy cập trang tài liệu về Advanced Integrated Visibility.

Lợi ích của Gói đăng ký Advanced Integrated Visibility dựa trên số theo dõi

Gói đăng ký Advanced Integrated Visibility dựa trên số theo dõi có các lợi ích sau:

  • Bạn có thể dễ dàng cập nhật và quản lý số theo dõi của dự án Advanced Integrated Visibility bằng điểm cuối API.
  • API này cho phép bạn liên kết nhiều số theo dõi với dự án của mình trong một giao dịch API duy nhất, thay vì liên kết từng số theo dõi riêng lẻ.
  • Bạn có thể gửi liên tiếp các yêu cầu API và xem chi tiết nhật ký thành công/thất bại của các yêu cầu này.

Cách thức hoạt động của Gói đăng ký Advanced Integrated Visibility dựa trên số theo dõi

Dùng các điểm cuối dưới đây để quản lý dự án Advanced Integrated Visibility của bạn:

Văn bản thay thế hình ảnh webhook

Bạn chỉ có thể truy cập API này thông qua phần tổng quan dự án như mô tả trong ảnh chụp màn hình bên trên.

Liên kết số theo dõi

Dùng điểm cuối này để kích hoạt công việc không đồng bộ nhằm liên kết một hoặc nhiều số theo dõi với một dự án Advanced Integrated Visibility cụ thể.

Thông tin đầu vào cần có cho yêu cầu này là:

  • Hành động – Cho biết hành động sẽ được thực hiện khi bạn gửi yêu cầu. Ví dụ: THÊM
  • Chi tiết số theo dõi – Cho biết số theo dõi

Bạn có thể liên kết tối đa 1000 số theo dõi trong một yêu cầu duy nhất. Phản hồi thành công cho yêu cầu này sẽ trả về jobID, trạng thái công việc hiện tại, cũng như thời gian tạo và hoàn tất công việc. Về sau, jobId này có thể được dùng để kiểm tra trạng thái của công việc không đồng bộ.

Trạng thái công việc dựa trên số theo dõi

Dùng điểm cuối này để lấy trạng thái của một công việc không đồng bộ (một hoặc nhiều yêu cầu liên tiếp trong hàng chờ) hoặc trạng thái của tất cả các công việc đã gửi.

Thông tin đầu vào cần có cho yêu cầu này là:

  • ID công việc – Cho biết ID công việc mà bạn định truy xuất trạng thái.

Lưu ý: ID công việc là thông tin đầu vào không bắt buộc đối với điểm cuối này. Nếu không cho biết ID công việc, bạn sẽ lấy trạng thái của tất cả các công việc đã gửi.

Phản hồi thành công cho yêu cầu này sẽ trả về jobID, trạng thái công việc hiện tại, cũng như thời gian tạo và hoàn tất công việc. Phản hồi sẽ hiển thị trạng thái hiện tại của công việc. Ngoài ra, phản hồi cũng sẽ chứa các thông báo thành công, thông báo lỗi hoặc cảnh báo để người dùng xem và khắc phục sự cố nếu có.

  • Nếu trạng thái công việc hiển thị là ĐÃ HOÀN TẤT thì có nghĩa là tất cả các số theo dõi đã được xác thực và xử lý thành công.
    • Trạng thái ĐÃ HOÀN TẤT ngụ ý rằng số theo dõi đã được xác thực và xử lý thành công chứ không ngụ ý rằng tất cả số theo dõi đều đã được thêm thành công vào dự án Advanced Integrated Visibility.
    • Nếu bạn cố gắng liên kết nhiều số theo dõi và chỉ một vài số được liên kết còn các số còn lại không liên kết được thì ngay cả khi đó, trạng thái công việc vẫn sẽ được cập nhật là ĐÃ HOÀN TẤT. Để xác nhận trạng thái của từng số theo dõi trong yêu cầu liên kết, bạn phải tải báo cáo xử lý hàng loạt xuống.
  • Lưu ý:

  • Nếu trạng thái công việc được hiển thị là THẤT BẠI, tức là vì nhiều lý do/lỗi nghiêm trọng mà hệ thống không thể xử lý yêu cầu và người dùng phải thử lại.

Sau đây là trạng thái và nội dung mô tả tương ứng:

TRẠNG THÁI CÔNG VIỆC MÔ TẢ

ĐÃ GỬI

    Công việc đã được gửi lên hệ thống sau tất cả các bước xác thực cơ bản và sẽ được xử lý không đồng bộ.

ĐƯỢC CHẤP NHẬN

    Công việc đã được chấp nhận và sẽ được đưa vào hàng chờ.

KHÔNG ĐƯỢC CHẤP NHẬN

    Công việc không được chấp nhận do lỗi nội bộ hoặc do hệ thống không hoạt động, người dùng cần thử lại.

ĐÃ ĐƯA VÀO HÀNG CHỜ

    Công việc đang chờ xử lý và quá trình xử lý có thể bắt đầu bất kỳ lúc nào.

ĐANG THỰC HIỆN

    Công việc đã được bắt đầu và đang trong quá trình thực hiện.

ĐÃ HOÀN TẤT

    Công việc đã được hoàn tất và báo cáo nhập hoặc tệp xuất đã sẵn sàng để người dùng tải xuống.

KHÔNG THÀNH CÔNG

    Công việc không thành công vì nhiều lý do và người dùng phải thử lại.

Thông tin chi tiết về công việc dựa trên số theo dõi

Dùng điểm cuối này để tải xuống báo cáo JSON cho công việc không đồng bộ đang ở trạng thái ĐÃ HOÀN TẤT.

Thông tin đầu vào cần thiết liên kết với yêu cầu này là:

  • ID công việc – Cho biết ID công việc mà bạn định truy xuất trạng thái.

Lưu ý:

  • ID công việc là thông tin đầu vào bắt buộc đối với điểm cuối này.
  • Mỗi lần, bạn chỉ có thể tải xuống báo cáo của một công việc không đồng bộ.
  • Nếu công việc chưa ở trạng thái ĐÃ HOÀN TẤT mà bạn lại cố tải báo cáo xuống thì thông báo lỗi sẽ hiển thị.

 

Phản hồi thành công cho yêu cầu này sẽ cung cấp cho bạn báo cáo về công việc ở định dạng JSON.

Quy tắc kinh doanh

  • Trong mỗi yêu cầu, bạn có thể liên kết tối đa 1.000 số theo dõi vận chuyển với dự án Advanced Integrated Visibility.
  • Không có giới hạn tối đa về số theo dõi mà bạn có thể liên kết với một dự án Advanced Integrated Visibility nhất định.
  • Mọi số theo dõi được liên kết với một dự án Advanced Integrated Visibility nhất định sẽ bị hủy liên kết sau 40 ngày.
  • Mọi trạng thái và thông tin chi tiết về ID công việc được tạo đối với một dự án Advanced Integrated Visibility nhất định sẽ không còn sau 90 ngày.
  • Thông tin theo dõi bảo mật như địa chỉ người nhận, chữ ký người nhận sẽ không truy cập được thông qua Gói đăng ký Advanced Integrated Visibility dựa trên số theo dõi.
CLOSE

Response

Copy