Bắt đầu
FedEx Developer Portal cung cấp một bộ Giao diện lập trình ứng dụng (API) để tích hợp FedEx vào các ứng dụng của bạn. Những hướng dẫn này sẽ chỉ cho bạn cách thiết lập tổ chức, tạo dự án, kiểm thử phần tích hợp, đưa dự án vào sản xuất, cũng như chứng thực API trong một số trường hợp.
Các loại người dùng:
FedEx cung cấp dịch vụ tích hợp cho ba loại người dùng: Người gửi FedEx, các giải pháp phần mềm đã xác minh gọi là Nhà cung cấp FedEx Compatible và Nhà cung cấp không tương thích.
Người gửi FedEx:
Công ty sử dụng dịch vụ vận chuyển của FedEx và cần tích hợp API FedEx vào ứng dụng của riêng họ.
Nhà cung cấp dịch vụ hoặc giải pháp:
Công ty cần tích hợp với API FedEx để xây dựng giải pháp, ứng dụng hoặc plugin có thể bán và/hoặc phân phối cho một tổ chức bên ngoài sử dụng dịch vụ vận chuyển của FedEx. Để biết công ty của bạn có phải là nhà cung cấp FedEx đã được xác minh hay không, hãy tìm kiếm trong danh mục toàn cầu của chúng tôi.
- Nhà cung cấp FedEx Compatible: Công ty đã được xác minh có thỏa thuận hợp đồng thông qua chương trình FedEx Compatible.
- Nhà cung cấp không tương thích: Giải pháp hoặc dịch vụ không được xác minh bởi chương trình FedEx Compatible.
Ở bên dưới, hãy chọn cách mô tả đúng nhất về doanh nghiệp của bạn. Bất kể loại người dùng, FedEx đều cung cấp hướng dẫn để giúp bạn bắt đầu.
Chọn để bắt đầu.
Which of the following best describes your business?
Select user
- Người gửi FedEx: Công ty tích hợp API FedEx vào ứng dụng của riêng họ.
- Nhà cung cấp FedEx Compatible Công ty được chương trình FedEx Compatible chứng thực, tích hợp API FedEx để xây dựng giải pháp, ứng dụng hoặc plugin có thể bán và/hoặc phân phối cho một tổ chức bên ngoài.
- Nhà cung cấp ngoài Compatible: Công ty tích hợp API FedEx để xây dựng giải pháp, ứng dụng hoặc plugin có thể bán và/hoặc phân phối cho một tổ chức bên ngoài.
Điều kiện
Bạn phải có ID người dùng FedEx để đăng nhập vào FedEx Developer Portal và tạo tổ chức.
Tham gia vào tổ chức hiện tại của công ty hoặc tạo tổ chức nếu chưa có tổ chức nào dành cho công ty của bạn.
Tạo tổ chức mới
Để tạo tổ chức của riêng bạn, hãy nhấp vào Tạo tổ chức ở menu điều hướng bên trái. Nếu bạn tạo tổ chức, bạn sẽ được tự động chỉ định là quản trị viên của tổ chức đó.
- Quản trị viên có thể mời người dùng tham gia tổ chức, chỉ định vai trò (ví dụ: người đóng góp hoặc người xem) và phân công dự án cho người dùng. Quản trị viên còn có thể quản lý các tài khoản vận chuyển.
- Để tìm hiểu thêm về những vai trò này, hãy xem Hướng dẫn quản trị tổ chức của chúng tôi.
Cung cấp thông tin về tổ chức
Cung cấp tên công ty của bạn, URL của trang web và tạo tên cho tổ chức. Đặt cho tổ chức tên mà người dùng khác có thể nhận ra. Tên này có thể được sử dụng để sắp xếp công ty của bạn vào các nhóm cụ thể hơn (ví dụ: phòng ban, bộ phận, khu vực, địa điểm) hoặc có thể giống với tên công ty.
Sau khi tạo tổ chức, với tư cách là quản trị viên, bạn có thể nhấp vào Quản lý tổ chức ở menu điều hướng bên trái để nhập thêm chi tiết.
Thêm tài khoản gửi hàng
Mở tab Tài khoản vận chuyển. Nhấp vào nút Thêm tài khoản.
- Nhập số tài khoản FedEx hiện tại của bạn, biệt danh cho tài khoản và địa chỉ thanh toán liên kết với tài khoản đó. Chúng tôi sẽ xác thực địa chỉ thanh toán để đảm bảo thông tin trùng khớp với chi tiết tài khoản và ngăn chặn các hoạt động gian lận. Nếu bạn hiện chưa có tài khoản FedEx, hãy mở tài khoản mới hoặc liên hệ với đại diện dịch vụ khách hàng của FedEx.
- Chấp nhận Thỏa thuận cấp phép người dùng cuối hoặc gửi cho người trong công ty bạn có thẩm quyền chấp nhận thỏa thuận.
Thêm tài khoản thanh toán
Mở tab Tài khoản thanh toán. Nhấp vào nút Thêm tài khoản thanh toán vào tổ chức của bạn.
- Nhập số tài khoản FedEx hiện tại của bạn, biệt danh cho tài khoản và địa chỉ thanh toán ở Hoa Kỳ liên kết với tài khoản đó. Chúng tôi sẽ xác thực địa chỉ thanh toán để đảm bảo thông tin trùng khớp với chi tiết tài khoản và ngăn chặn các hoạt động gian lận. Nếu bạn hiện chưa có tài khoản FedEx, hãy mở tài khoản mới hoặc liên hệ với đại diện dịch vụ khách hàng của FedEx. Địa chỉ thanh toán của tài khoản phải ở Hoa Kỳ.
- Chấp nhận Thỏa thuận cấp phép người dùng cuối hoặc gửi cho người trong công ty bạn có thẩm quyền chấp nhận thỏa thuận.
Mời người dùng
Quản trị viên có thể mời người dùng vào tổ chức và chỉ định vai trò, phân công dự án cho người dùng. Mở tab Người dùng. Nhấp vào nút Thêm người dùng.
- Chọn vai trò người dùng: Người xem, Người đóng góp hoặc Quản trị viên.
- Nếu bạn hiện đang có dự án, hãy phân công một dự án cho người dùng. Bạn cũng có thể phân công dự án cho người dùng trong bất kỳ trang Tổng quan về dự án nào.
- Nhập địa chỉ email của những người dùng bạn muốn tham gia vào tổ chức trong vai trò đã chọn.
Tham gia tổ chức hiện có
Bước 1: Yêu cầu quản trị viên của tổ chức gửi cho bạn lời mời.
Nếu công ty của bạn đã tạo tổ chức, hãy yêu cầu quản trị viên của tổ chức mời bạn tham gia. Bạn sẽ có 24 giờ để chấp nhận lời mời. Nếu bỏ lỡ khoảng thời gian đó, bạn có thể yêu cầu họ gửi lại lời mời bất cứ lúc nào.
Bước 2: Chấp nhận lời mời.
Để chấp nhận lời mời, bạn sẽ cần đăng nhập bằng ID người dùng và mật khẩu hiện tại của bạn. Trong trường hợp ID người dùng hiện tại đã được liên kết với tổ chức, bạn sẽ cần tạo ID người dùng mới.
Tạo dự án API
Truy cập trang Dự án của tôi và mở tab API. Nhấp vào nút Tạo dự án API.
Bước 1: Chọn các API bạn muốn đưa vào dự án
Xem xét hạn mức API, giới hạn tốc độ và chi tiết chứng thực API.
Bước 2: Đặt cấu hình chi tiết dự án
- Đặt tên dễ nhận biết cho dự án, chỉ có ở tổ chức của bạn.
- Chọn quốc gia bất kỳ mà bạn muốn vận chuyển nội địa, để chúng tôi chỉ định tài khoản vận chuyển thử nghiệm cho bạn. Để thử nghiệm vận chuyển nội địa gói hàng tại một quốc gia châu Âu, bạn phải có tài khoản thử nghiệm riêng cho từng quốc gia. Bạn luôn có thể thêm/xóa quốc gia vào lúc khác.
- Để nhận thông báo về các bản cập nhật API mới nhất và mọi thông tin liên quan đến việc ngừng hoạt động, hãy thiết lập các tùy chọn thông báo.
Bước 3: Đọc và chấp nhận các điều khoản, bao gồm cả Thỏa thuận cấp phép của FedEx Developer Portal
Sau khi chấp nhận các điều khoản và nhấp vào nút Tạo, bạn sẽ nhìn thấy màn hình xác nhận. Khi đó, bạn có thể xem thông tin xác thực kiểm thử trong dự án mới.
Tạo dự án webhook
Điều kiện
- Xem xét giá: người đăng ký cần thanh toán phí hằng tháng dựa trên số lượng số theo dõi. Tham khảo Hướng dẫn về giá để tìm hiểu thêm về giá.
- Thiết lập tài khoản: Webhook Advanced Integrated Visibility yêu cầu tài khoản thanh toán ở Hoa Kỳ và ít nhất một tài khoản gửi hàng, hai loại tài khoản này loại trừ lẫn nhau. Chỉ quản trị viên mới có thể thêm tài khoản thanh toán và tài khoản vận chuyển trên trang Quản lý tổ chức.
Tạo một URL (call back) hợp lệ trong nền tảng hoặc ứng dụng đích
URL đích sẽ được sử dụng để nhận mã xác thực và tin nhắn cũng như thông báo phần tải webhook từ FedEx. URL phải sử dụng HTTPS để đảm bảo tính bảo mật. URL của bạn sẽ bị chặn nếu bao gồm:
- Không gian IP RFC1918
- fedex.com hoặc miền phụ tương ứng
- Địa chỉ IP trong URL này (kể cả localhost, 127.0.0.1)
Tạo mã thông báo bảo mật
Mã thông báo bảo mật này có thể được sử dụng làm khóa bí mật để xác thực và xác nhận thông tin được truyền giữa tổ chức của bạn và FedEx. Mã thông báo bảo mật phải bao gồm:
- Độ dài tối thiểu 26 ký tự và tối đa 100 ký tự
- 1 ký tự viết hoa
- 1 ký tự viết thường
- 1 ký tự số
Ví dụ: Y1F6OiVUQW2JPSElmRE9U0IY5
Sau khi xác định URL và mã thông báo bảo mật, bạn đã sẵn sàng tạo dự án webhook. Truy cập trang Dự án của tôi và mở tab Webhook. Nhấp vào nút Tạo dự án webhook.
Chọn loại gói đăng ký
Người gửi FedEx có thể đăng ký nhận thông báo về các sự kiện theo số tài khoản hoặc số theo dõi.
Bước 1: Xác nhận tài khoản thanh toán và chọn tính năng
- Xem xét và xác nhận tài khoản thanh toán mặc định được hiển thị hoặc chọn một tài khoản khác từ tổ chức của bạn.
- Đặt cấu hình dự án bằng cách chọn các tính năng như tùy chọn bằng chứng giao hàng, tùy chọn giao hàng ước tính, sự kiện theo dõi và lọc theo sự kiện.
Bước 2: Nhập chi tiết dự án
- Đặt tên dễ nhận biết cho dự án, chỉ có ở tổ chức của bạn.
- Nhập chi tiết mã thông báo bảo mật và URL đích mà bạn đã tạo trong quá trình xác thực trước khi thiết lập (xem các bước ở trên).
- Để nhận thông báo về các bản cập nhật webhook mới nhất và mọi thông tin liên quan đến việc ngừng hoạt động, hãy nhập địa chỉ email và ngôn ngữ ưu tiên.
Bước 3: Đọc và chấp nhận các điều khoản
Sau khi chấp nhận các điều khoản – bao gồm cả Thỏa thuận cấp phép của FedEx Developer Portal và Biểu mẫu đặt hàng – và nhấp vào nút Tạo, bạn sẽ nhìn thấy màn hình xác nhận.
Tùy gọi đăng ký đã chọ, có thể bạn cần thực hiện thêm các bước khác. Truy cập tài liệu để tìm hiểu thêm.
Trên trang Tổng quan về dự án API, hãy lấy thông tin xác thực kiểm thử – khóa API, khóa bí mật và tài khoản vận chuyển – từ tab Khóa kiểm thử.
Bước 1: Yêu cầu mã thông báo truy cập OAuth
Mã thông báo truy cập OAuth phải được sử dụng cho mỗi giao dịch API. Mã thông báo này chỉ có hiệu lực trong một giờ, nên bạn sẽ cần lập trình cho ứng dụng làm mới mã thông báo trước khi phiên hết hạn. Tham khảo tài liệu về Ủy quyền cho API để biết thêm chi tiết.
Bước 2: Xem xét tài liệu về API
Nhấp vào tài liệu về từng API để đọc bối cảnh kinh doanh và hiểu cách sử dụng API. Đăng nhập để tải bộ sưu tập API JSON xuống thông qua nút ở đầu trang tài liệu. Bạn cũng có thể xem các ví dụ về yêu cầu điểm cuối phù hợp với nhu cầu tích hợp của bạn.
Bước 3: Sử dụng sandbox để kiểm thử các giao dịch mẫu
Nhấp vào điểm cuối mong muốn trong menu điều hướng bên trái để chuyển đến sandbox cụ thể đó. Xác định những yêu cầu mẫu phù hợp với trường hợp sử dụng của bạn, sau đó sử dụng thông tin xác thực kiểm thử và URL kiểm thử của FedEx để thực hiện các lệnh gọi đến điểm cuối như được mô tả trong yêu cầu mẫu. Xác minh rằng phản hồi lệnh gọi API mà bạn nhận được khớp với phản hồi hiển thị trong tài liệu. Tìm hiểu thêm về trải nghiệm kiểm thử trong Hướng dẫn sử dụng sandbox được mô phỏng.
Kiểm thử với webhook
Bước kiểm thử có thể giúp bạn biết rõ hơn liệu URL bạn tạo có hợp lệ hay không. Bước này cho phép FedEx xác định và xây dựng kết nối với URL của bạn để gửi dữ liệu. Việc kiểm thử còn có thể cung cấp dữ liệu kiểm thử mẫu, giúp bạn kiểm tra và xác nhận xem bạn có thể xử lý dữ liệu theo dõi được cung cấp trong ứng dụng của mình hay không. Tuy nhiên, việc kiểm thử không xác thực URL. Truy cập tài liệu về webhook để tìm hiểu cách kiểm thử URL webhook.
Truy cập trang Tổng quan về dự án và mở tab Khóa sản xuất. Các dự án gói đăng ký Advanced Integrated Visibility dựa trên số tài khoản không cần đưa vào sản xuất.
Bước 1: Đặt cấu hình dự án
- Đổi tên khóa khi cần.
- Xem lại số tài khoản bạn đã chọn ở bước 1 trong quy trình tạo dự án. Thông tin này được sử dụng để đưa dự án của bạn vào sản xuất. Sau khi dự án của bạn đi vào bước sản xuất, bạn có thể thêm nhiều tài khoản hơn nếu cần.
Bước 2: Nhận khóa dự án
Khóa API sản xuất và khóa bí mật sản xuất sẽ hiển thị để bạn lưu trữ ở nơi an toàn. Để đảm bảo an toàn cho khóa bí mật sản xuất của bạn, chúng tôi chỉ hiển thị khóa một lần. Nếu để mất, bạn có thể tạo khóa mới.
Sau khi nhận khóa dự án và nhấp vào Tiếp, bạn sẽ thấy chi tiết dự án ở tab Khóa sản xuất.
- Để thêm các tài khoản vận chuyển khác vào dự án của bạn, hãy nhấp vào Chỉnh sửa ở đầu bảng tài khoản vận chuyển.
Các bước chứng thực khác nhau tùy theo khu vực
Các bước sau đây chỉ áp dụng cho khách hàng ở Hoa Kỳ và Canada. Nếu bạn sống ở ngoài hai quốc gia này, hãy truy cập trang Chứng thực API để tìm thông tin hỗ trợ.
Một số API yêu cầu chứng thực nhãn vận chuyển để sử dụng trong môi trường sản xuất của chúng tôi. Tìm hiểu xem API của bạn có yêu cầu chứng thực hay không.
Bước 1: Phát triển và thử nghiệm API FedEx với ứng dụng hỗ trợ web của bạn
Một khi đã hoàn tất việc phát triển ứng dụng hỗ trợ web, đã đến lúc hoàn tất thử nghiệm bằng thông tin thử nghiệm ((các) tài khoản gửi hàng, Mã API và Mã khóa bí mật thử nghiệm). Mã API và Mã khóa bí mật thử nghiệm của bạn sẽ được hiển thị trên trang Tổng quan về dự án và có thể xem bất cứ lúc nào.
Bước 2: Đưa dự án của bạn vào sản xuất
Sau khi đã thử nghiệm với API FedEx, bạn cần bắt đầu quy trình chứng thực bằng việc đưa dự án của mình vào sản xuất trên FedEx Developer Portal. Một khi đã hoàn tất thành công, bạn sẽ thấy Khóa API và Khóa bí mật cho bước sản xuất của mình. Bạn sẽ chỉ nhìn thấy Khóa bí mật sản xuất một lần nhưng sau đó, bạn có thể tạo lại khóa này.
Bước 3: Điền vào Tờ bìa nhãn
Điền đầy đủ thông tin liên hệ thích hợp và các dịch vụ mà bạn dự định triển khai vào Tờ bìa nhãn. Điền cả số tài khoản và khóa sản xuất.
Bước 4: Tạo nhãn kiểm thử và gửi đến Nhóm phân tích mã vạch
Tạo nhãn kiểm thử trong môi trường kiểm thử FedEx liên kết với ứng dụng rồi gửi nhãn kiểm thử cho (các) đội ngũ đánh giá nhãn FedEx để được phê duyệt. Nhóm phân tích mã vạch cần ba ngày làm việc để hoàn thành đánh giá nhãn.
Tuân thủ các phương thức tối ưu sau đây để tránh chậm trễ trong quá trình xử lý:
- Nhãn phải được in và quét với độ phân giải tối thiểu là 600 DPI. KHÔNG GỬI CÁC TỆP DO API TẠO RA.
- Đối với máy in nhiệt, phải yêu cầu loại hình ảnh của nhãn phù hợp với mẫu máy in. Ví dụ: ZPLII cho máy in Zebra.
- Dùng địa chỉ của người gửi/người nhận khi tạo mẫu nhãn để đánh giá. Chỉ tạo mẫu nhãn cho các dịch vụ cụ thể đang đăng ký.
- Nhãn Thu tiền mặt khi giao hàng (C.O.D.) của FedEx® phải đi kèm nhãn trả hàng C.O.D. tương ứng.
- Các lô hàng FedEx International Express® phải đính kèm nhãn Vận đơn hàng không (AWB) phụ/thứ cấp.
- Lô hàng nhiều kiện (MPS) phải đính kèm một nhãn cho mỗi gói hàng trong lô.
- Gửi bản PDF và Tờ bìa nhãn đến địa chỉ email label@fedex.com.
- Nhãn thực có thể gửi đến địa chỉ sau:
FedEx Services
WTC-Business Solutions Testing
10 FedEx Parkway
2nd Floor Horizontal
Collierville, TN 38017
Nếu nhãn được quét không có những khiếm khuyết nhìn thấy được (ví dụ như các đường chạy ngang mã vạch, đốm mực hoặc hư hại thực tế) thì nhãn có thể qua bước kiểm tra và được phê duyệt.
Nếu bạn gửi nhãn thực, hãy chú ý đến chất lượng in và những phần bị to/nhỏ của nhãn do vô tình (tức là thay đổi kích thước). Đây là hai lý do chính khiến nhãn không vượt qua được quy trình đánh giá nhãn.
Bước 5: Xem xét việc đánh giá nhãn
Nhóm phân tích mã vạch sẽ đánh giá nhãn thử nghiệm được nộp và phê duyệt hoặc từ chối nhãn. Nhóm phân tích mã vạch sẽ liên hệ với bạn về việc phê duyệt hay từ chối nhãn đã nộp. Nếu được phê duyệt, nhãn sẽ chuyển sang bước tiếp theo. Nếu nhãn bị từ chối, hãy sửa lại nhãn theo hướng dẫn và nộp lại để phê duyệt.
Bước 6: Kích hoạt ứng dụng
Ngay khi Nhóm phân tích mã vạch phê duyệt nhãn thử nghiệm để sang trạng thái sản xuất, họ sẽ ủy quyền thông tin xác thực sản phẩm của bạn để gửi giao dịch nhãn vận chuyển đã xác định và thông báo cho bạn qua email khi chứng thực thành công. Quy trình phê duyệt được thực hiện cho từng dự án.
Bước 7: Thay thế URL và thông tin
Thay thế URL và thông tin thử nghiệm bằng URL và thông tin sản phẩm. Thử nghiệm lại việc triển khai trong môi trường sản xuất bằng dữ liệu mẫu.
Điều kiện
Công ty của bạn phải đang là nhà cung cấp FedEx Compatible. Nếu công ty bạn không tham gia chương trình Compatible, hãy thay đổi lựa chọn ở trên thành "Nhà cung cấp ngoài Compatible".
Bước 1: Nhận lời mời tham gia tổ chức
FedEx sẽ tạo tổ chức và mời một thành viên nhóm tham gia tổ chức. Người dùng này sẽ được chỉ định làm quản trị viên cho tổ chức của bạn.
Bước 2: Chấp nhận lời mời
Để chấp nhận lời mời, bạn sẽ cần đăng nhập bằng ID người dùng và mật khẩu hiện tại của bạn. Trong trường hợp ID người dùng hiện tại đã được liên kết với tổ chức, bạn sẽ cần tạo ID người dùng mới.
Bước 3: Mời người dùng
Quản trị viên có thể mời người dùng vào tổ chức và chỉ định vai trò, phân công dự án cho người dùng. Mở tab Người dùng. Nhấp vào nút Thêm người dùng.
- Chọn vai trò người dùng: Người xem, Người đóng góp hoặc Quản trị viên. Tìm hiểu thêm về các vai trò trong Hướng dẫn quản trị tổ chức của chúng tôi.
- Nếu bạn hiện đang có dự án, hãy phân công một dự án cho người dùng. Bạn cũng có thể phân công dự án cho người dùng trong bất kỳ trang Tổng quan về dự án nào.
- Nhập địa chỉ email của những người dùng bạn muốn tham gia vào tổ chức trong vai trò đã chọn.
Truy cập Danh mục API để xác định các API hoặc webhook phù hợp cho giải pháp của bạn. Tư vấn viên công nghệ cho khách hàng (CTC) của FedEx và người quản lý Kênh Compatible có thể hỗ trợ bạn chọn API phù hợp cho giải pháp theo nhu cầu kinh doanh.
Bước 1: Điền vào PIW
Quay lại Cộng đồng nhà cung cấp Compatible (CPC) để điền vào Phiếu thông tin sản phẩm (PIW).
Bước 2: Xem xét dự án do FedEx tạo
Sau khi PIW được phê duyệt, FedEx sẽ tạo (các) dự án của bạn. Mỗi phiên bản của từng giải pháp sẽ có một dự án riêng biệt trên FedEx Developer Portal.
Bước 3: Tham dự buổi minh họa API với nhóm của bạn
Đội ngũ FedEx Compatible cùng với CTC của FedEx và đội ngũ Xác minh sẽ tổ chức buổi minh họa kỹ thuật về API với nhóm của bạn. Đội ngũ FedEx sẽ thảo luận về việc Xác minh chương trình Compatible, các tính năng và chức năng API mới cũng như trả lời các câu hỏi.
Trên trang Tổng quan về dự án API, hãy lấy thông tin xác thực kiểm thử – khóa API và khóa bí mật – từ tab Khóa kiểm thử.
Bước 1: Tạo khóa khách hàng
Sử dụng Credential Registration API để tạo khóa khách hàng. Đây là API riêng tư chỉ có trong phần API ở cuối trang Tổng quan về dự án API.
Bước 2: Yêu cầu mã thông báo truy cập OAuth
Mã thông báo truy cập OAuth phải được sử dụng cho mỗi giao dịch API. Mã thông báo này chỉ có hiệu lực trong một giờ, nên bạn sẽ cần lập trình cho ứng dụng làm mới mã thông báo trước khi phiên hết hạn. Tham khảo tài liệu về Ủy quyền cho API để biết thêm chi tiết. Khi xem mã mẫu, hãy nhớ chọn "Người bán lại" trong danh sách thả xuống có các mẫu.
Bước 3: Xem xét tài liệu về API
Nhấp vào tài liệu về từng API để đọc bối cảnh kinh doanh và hiểu cách sử dụng API. Đăng nhập để tải bộ sưu tập API JSON xuống thông qua nút ở đầu trang tài liệu. Bạn cũng có thể xem các ví dụ về yêu cầu điểm cuối phù hợp với nhu cầu tích hợp của bạn.
Bước 4: Sử dụng sandbox để kiểm thử các giao dịch mẫu
Nhấp vào điểm cuối mong muốn trong menu điều hướng bên trái để chuyển đến sandbox cụ thể đó. Xác định những yêu cầu mẫu phù hợp với trường hợp sử dụng của bạn, sau đó sử dụng thông tin xác thực kiểm thử và URL kiểm thử của FedEx để thực hiện các lệnh gọi đến điểm cuối như được mô tả trong yêu cầu mẫu. Xác minh rằng phản hồi lệnh gọi API mà bạn nhận được khớp với phản hồi hiển thị trong tài liệu. Tìm hiểu thêm về trải nghiệm kiểm thử trong Hướng dẫn sử dụng sandbox được mô phỏng.
Bước 5: Xác minh từng giải pháp
Sau khi kiểm thử đầy đủ các giải pháp của bạn, hãy gửi các trường hợp kiểm thử cho đội ngũ Xác minh để xác minh từng giải pháp. FedEx sẽ xem xét đầy đủ mọi nội dung được gửi và cập nhật thông tin cho bạn sau khi quá trình xác minh được phê duyệt.
Kiểm thử với webhook
Nếu tổ chức của bạn có quyền truy cập vào webhook, bước kiểm thử có thể giúp bạn biết rõ hơn liệu URL bạn tạo có hợp lệ hay không. Bước này cho phép FedEx xác định và xây dựng kết nối với URL của bạn để gửi dữ liệu. Việc kiểm thử còn có thể cung cấp dữ liệu kiểm thử mẫu, giúp bạn kiểm tra và xác nhận xem bạn có thể xử lý dữ liệu theo dõi được cung cấp trong ứng dụng của mình hay không. Tuy nhiên, việc kiểm thử không xác thực URL. Truy cập tài liệu về webhook để tìm hiểu cách kiểm thử URL webhook.
Sau đó, FedEx sẽ đưa (các) dự án vào sản xuất. Truy cập trang Tổng quan về dự án API và mở tab Khóa sản xuất. Nhấp vào liên kết Tạo khóa bí mật dưới cột Khóa bí mật.
Giờ đây, bạn có thể thử nghiệm lại việc triển khai trong môi trường sản xuất bằng dữ liệu mẫu.
Điều kiện
Bạn phải có ID người dùng và tài khoản FedEx để đăng nhập vào FedEx Developer Portal và tạo tổ chức.
Tham gia vào tổ chức hiện tại của công ty hoặc tạo tổ chức nếu chưa có tổ chức nào dành cho công ty bạn.
Tạo tổ chức mới
Để tạo tổ chức của riêng bạn, hãy nhấp vào Tạo tổ chức ở menu điều hướng bên trái. Nếu bạn tạo tổ chức, bạn sẽ được tự động chỉ định là quản trị viên của tổ chức đó.
- Quản trị viên có thể mời người dùng tham gia tổ chức, chỉ định vai trò (ví dụ: người đóng góp hoặc người xem) và phân công dự án cho người dùng.
- Để tìm hiểu thêm về những vai trò này, hãy xem Hướng dẫn quản trị tổ chức của chúng tôi.
Bước 1: Cung cấp thông tin về tổ chức
- Cung cấp tên công ty, URL trang web và email doanh nghiệp để phục vụ mục đích xác minh.
- Tạo tên tổ chức. Đặt cho tổ chức tên gọi mà người dùng khác có thể nhận ra. Tên này có thể được sử dụng để sắp xếp công ty vào các nhóm cụ thể hơn (ví dụ: phòng ban, bộ phận, khu vực, địa điểm) hoặc có thể giống với tên công ty của bạn.
- Nhập thông tin địa điểm trụ sở công ty và nơi bạn dự định bán hoặc phân phối giải pháp phần mềm của mình.
Bước 2: Thêm và xác thực tài khoản
Nhập số tài khoản FedEx hiện tại của bạn, biệt danh cho tài khoản và địa chỉ thanh toán liên kết với tài khoản đó. Chúng tôi sẽ xác thực địa chỉ thanh toán để đảm bảo thông tin trùng khớp với chi tiết tài khoản và ngăn chặn các hoạt động gian lận. Nếu bạn hiện chưa có tài khoản FedEx, hãy mở tài khoản mới hoặc liên hệ với đại diện dịch vụ khách hàng của FedEx.
- Với tư cách là nhà cung cấp bên thứ ba tham gia Chương trình dành cho đơn vị tích hợp của FedEx, tài khoản được sử dụng cho lần đăng ký ban đầu này phải thuộc về Đơn vị tích hợp là bạn. Bạn không được phép sử dụng tài khoản khách hàng cuối.
- Tài khoản này sẽ được đặt làm tài khoản thanh toán mặc định cho tổ chức của bạn.
Bước 3: Đọc và chấp nhận các điều khoản
Sau khi chấp nhận Thỏa thuận dành cho nhà phát triển và Cẩm nang về chương trình, bạn sẽ nhìn thấy màn hình xác nhận. Với tư cách là người quản trị viên của tổ chức mới, bạn có thể nhấp vào Quản lý tổ chức ở menu điều hướng bên trái để xem hoặc chỉnh sửa chi tiết.
Bước 4: Mời người dùng
Quản trị viên có thể mời người dùng vào tổ chức và chỉ định vai trò, phân công dự án cho người dùng. Mở tab Người dùng. Nhấp vào nút Thêm người dùng.
- Chọn vai trò người dùng: Người xem, Người đóng góp hoặc Quản trị viên.
- Nếu bạn hiện đang có dự án, hãy phân công một dự án cho người dùng. Bạn cũng có thể phân công dự án cho người dùng trong bất kỳ trang Tổng quan về dự án nào.
- Nhập địa chỉ email của những người dùng bạn muốn tham gia vào tổ chức trong vai trò đã chọn.
Tham gia tổ chức hiện có
Bước 1: Yêu cầu quản trị viên của tổ chức gửi cho bạn lời mời.
Nếu công ty của bạn đã tạo tổ chức, hãy yêu cầu quản trị viên của tổ chức mời bạn tham gia. Bạn sẽ có 24 giờ để chấp nhận lời mời. Nếu bỏ lỡ khoảng thời gian đó, bạn có thể yêu cầu họ gửi lại lời mời bất cứ lúc nào.
Bước 2: Chấp nhận lời mời.
Để chấp nhận lời mời, bạn sẽ cần đăng nhập bằng ID người dùng và mật khẩu hiện tại của bạn. Trong trường hợp ID người dùng hiện tại đã được liên kết với tổ chức, bạn sẽ cần tạo ID người dùng mới.
Truy cập trang Dự án của tôi và mở tab API. Nhấp vào nút Tạo dự án API.
Bước 1: Chọn các API bạn muốn đưa vào dự án
Xem xét hạn mức Ship API, Rate API và API khác, giới hạn tốc độ và chi tiết chứng thực API.
- Nếu bạn chọn Ship API hoặc Open Ship API, Service Availability API và Trade Documents Upload API sẽ tự động được chọn vì đây là những API cần thiết khi sử dụng Ship API hoặc Open Ship API.
Bước 2: Đặt cấu hình chi tiết dự án
Đặt tên dễ nhận biết cho dự án, chỉ có ở tổ chức của bạn.
Bước 3: Đọc và chấp nhận các điều khoản, bao gồm cả Thỏa thuận cấp phép của FedEx Developer Portal
Sau khi chấp nhận các điều khoản và nhấp vào nút Tạo, bạn sẽ nhìn thấy màn hình xác nhận. Khi đó, bạn có thể xem thông tin xác thực kiểm thử trong dự án mới.
Tạo dự án webhook
Điều kiện
- Xem xét giá: người đăng ký cần thanh toán phí hằng tháng dựa trên số lượng số theo dõi. Tham khảo Hướng dẫn về giá để tìm hiểu thêm về giá.
- Thiết lập tài khoản: Advanced Integrated Visibility yêu cầu tài khoản thanh toán ở Hoa Kỳ và ít nhất một tài khoản vận chuyển hai loại tài khoản này loại trừ lẫn nhau. Chỉ quản trị viên mới có thể thêm tài khoản thanh toán và tài khoản vận chuyển trên trang Quản lý tổ chức.
Tạo một URL (call back) hợp lệ trong nền tảng hoặc ứng dụng đích
URL đích sẽ được sử dụng để nhận mã xác thực và tin nhắn cũng như thông báo phần tải webhook từ FedEx. URL phải sử dụng HTTPS để đảm bảo tính bảo mật. URL của bạn sẽ bị chặn nếu bao gồm:
- Không gian IP RFC1918
- fedex.com hoặc miền phụ tương ứng
- Địa chỉ IP trong URL này (kể cả localhost, 127.0.0.1)
Tạo mã thông báo bảo mật
Mã thông báo bảo mật này có thể được sử dụng làm khóa bí mật để xác thực và xác nhận thông tin được truyền giữa tổ chức của bạn và FedEx. Mã thông báo bảo mật phải bao gồm:
- Độ dài tối thiểu 26 ký tự và tối đa 100 ký tự
- 1 ký tự viết hoa
- 1 ký tự viết thường
- 1 ký tự số
Ví dụ: Y1F6OiVUQW2JPSElmRE9U0IY5
Sau khi xác định URL và mã thông báo bảo mật, bạn đã sẵn sàng tạo dự án webhook. Truy cập trang Dự án của tôi và mở tab Webhook. Nhấp vào nút Tạo dự án webhook.
Chọn loại gói đăng ký
Người gửi FedEx có thể đăng ký nhận thông báo về các sự kiện theo số tài khoản hoặc số theo dõi.
Bước 1: Xác nhận tài khoản thanh toán và chọn tính năng
- Xem xét và xác nhận tài khoản thanh toán mặc định được hiển thị hoặc chọn một tài khoản khác từ tổ chức của bạn.
- Đặt cấu hình dự án bằng cách chọn các tính năng như tùy chọn bằng chứng giao hàng, tùy chọn giao hàng ước tính, sự kiện theo dõi và lọc theo sự kiện.
Bước 2: Nhập chi tiết dự án
- Đặt tên dễ nhận biết cho dự án, chỉ có ở tổ chức của bạn.
- Nhập chi tiết mã thông báo bảo mật và URL đích mà bạn đã tạo trong quá trình xác thực trước khi thiết lập (xem các bước ở trên).
- Để nhận thông báo về các bản cập nhật webhook mới nhất và mọi thông tin liên quan đến việc ngừng hoạt động, hãy nhập địa chỉ email và ngôn ngữ ưu tiên.
Bước 3: Đọc và chấp nhận các điều khoản
Sau khi chấp nhận các điều khoản – bao gồm cả Thỏa thuận cấp phép của FedEx Developer Portal và Biểu mẫu đặt hàng – và nhấp vào nút Tạo, bạn sẽ nhìn thấy màn hình xác nhận.
Tùy gọi đăng ký đã chọ, có thể bạn cần thực hiện thêm các bước khác. Truy cập tài liệu để tìm hiểu thêm.
Trên trang Tổng quan về dự án API, hãy lấy thông tin xác thực kiểm thử – khóa API và khóa bí mật – từ tab Khóa kiểm thử.
Bước 1: Yêu cầu mã thông báo truy cập OAuth
Mã thông báo truy cập OAuth phải được sử dụng cho mỗi giao dịch API. Mã thông báo này chỉ có hiệu lực trong một giờ, nên bạn sẽ cần lập trình cho ứng dụng làm mới mã thông báo trước khi phiên hết hạn. Tham khảo tài liệu về Ủy quyền cho API để biết thêm chi tiết.
Bước 2: Xem xét tài liệu về API
Nhấp vào tài liệu về từng API để đọc bối cảnh kinh doanh và hiểu cách sử dụng API. Đăng nhập để tải bộ sưu tập API JSON xuống thông qua nút ở đầu trang tài liệu. Bạn cũng có thể xem các ví dụ về yêu cầu điểm cuối phù hợp với nhu cầu tích hợp của bạn.
Bước 3: Sử dụng sandbox để kiểm thử các giao dịch mẫu
Nhấp vào điểm cuối mong muốn trong menu điều hướng bên trái để chuyển đến sandbox cụ thể đó. Xác định những yêu cầu mẫu phù hợp với trường hợp sử dụng của bạn, sau đó sử dụng thông tin xác thực kiểm thử và URL kiểm thử của FedEx để thực hiện các lệnh gọi đến điểm cuối như được mô tả trong yêu cầu mẫu. Xác minh rằng phản hồi lệnh gọi API mà bạn nhận được khớp với phản hồi hiển thị trong tài liệu. Tìm hiểu thêm về trải nghiệm kiểm thử trong Hướng dẫn sử dụng sandbox được mô phỏng.
Kiểm thử với webhook
Nếu tổ chức của bạn có quyền truy cập vào webhook, bước kiểm thử có thể giúp bạn biết rõ hơn liệu URL bạn tạo có hợp lệ hay không. Bước này cho phép FedEx xác định và xây dựng kết nối với URL của bạn để gửi dữ liệu. Việc kiểm thử còn có thể cung cấp dữ liệu kiểm thử mẫu, giúp bạn kiểm tra và xác nhận xem bạn có thể xử lý dữ liệu theo dõi được cung cấp trong ứng dụng của mình hay không. Tuy nhiên, việc kiểm thử không xác thực URL. Truy cập tài liệu về webhook để tìm hiểu cách kiểm thử URL webhook.
Truy cập trang Tổng quan về dự án và mở tab Khóa sản xuất. Các dự án gói đăng ký Advanced Integrated Visibility dựa trên số tài khoản không cần đưa vào sản xuất.
Bước 1: Đặt cấu hình dự án
Đổi tên khóa khi cần.
Bước 2: Nhận khóa dự án
Khóa API sản xuất và khóa bí mật sản xuất sẽ hiển thị để bạn lưu trữ ở nơi an toàn. Để đảm bảo an toàn cho khóa bí mật sản xuất của bạn, chúng tôi chỉ hiển thị khóa một lần. Nếu để mất, bạn có thể tạo khóa mới.
Sau khi nhận khóa dự án và nhấp vào Tiếp, bạn sẽ thấy chi tiết dự án ở tab Khóa sản xuất.
Các bước chứng thực khác nhau tùy theo khu vực
Các bước sau đây chỉ áp dụng cho khách hàng ở Hoa Kỳ và Canada. Nếu bạn sống ở ngoài hai quốc gia này, hãy truy cập trang Chứng thực API để tìm thông tin hỗ trợ.
Một số API yêu cầu chứng thực nhãn vận chuyển để sử dụng trong môi trường sản xuất của chúng tôi. Tìm hiểu xem API của bạn có yêu cầu chứng thực hay không.
Bước 1: Phát triển và thử nghiệm API FedEx với ứng dụng hỗ trợ web của bạn
Sau khi bạn hoàn tất việc phát triển ứng dụng hỗ trợ nền tảng web, đã đến lúc hoàn tất kiểm thử bằng thông tin xác thực kiểm thử (khóa API kiểm thử và khóa bí mật). Khóa API kiểm thử và Khóa bí mật sẽ hiển thị trên trang Tổng quan về dự án và bạn có thể xem bất cứ lúc nào.
- Xác định tất cả trường hợp kiểm thử đối với các khu vực/vùng lãnh thổ mà bạn muốn xác thực và triển khai giải pháp của mình. Bạn có thể tìm thấy các trường hợp kiểm thử trong Cơ sở cho trường hợp kiểm thử đơn vị tích hợp.
- Trước khi chạy trường hợp kiểm thử, bạn sẽ cần thực hiện các giao dịch đăng ký cho các số tài khoản kiểm thử tương ứng có trong cơ sở cho trường hợp kiểm thử.
- Sau đó, chạy tất cả trường hợp kiểm thử đối với các khu vực/vùng lãnh thổ mà bạn muốn xác thực và triển khai giải pháp của mình.
Bước 2: Điền vào PIW và Tờ bìa xác thực
Điền đầy đủ thông tin liên hệ thích hợp cũng như các dịch vụ và chức năng mà bạn dự định cung cấp vào Phiếu thông tin sản phẩm (PIW) và Tờ bìa xác thực đơn vị tích hợp.
Bước 3: Tạo và gửi các tài liệu cho đội ngũ Xác thực
Thu thập các tài liệu sau, nén thành tệp .zip và gửi qua email đến validationmtp@fedex.com. Bạn nên gửi tệp ở định dạng .zip để giảm nguy cơ nhà cung cấp dịch vụ email chặn tài liệu gửi.
- PIW đã điền đầy đủ thông tin về tất cả vùng lãnh thổ/khu vực được chỉ định (định dạng: PDF)
- Tờ bìa xác thực đã điền đầy đủ thông tin (định dạng: PDF)
- Ảnh chụp màn hình các tài liệu sau đây (định dạng: PDF):
- Giải pháp phục vụ khách hàng hiển thị các dịch vụ FedEx/tùy chọn xử lý đặc biệt
- Tuyên bố miễn trừ trách nhiệm
- Thỏa thuận cấp phép người dùng cuối
- Quy trình đăng ký của khách hàng cuối
- Giao dịch đăng ký của khách hàng cuối – Xác thực đa yếu tố bao gồm hóa đơn và mã PIN dành cho tin nhắn SMS, cuộc gọi và email (định dạng: tệp yêu cầu/phản hồi JSON)
- Bản quét nhãn in thực tế của tất cả các trường hợp kiểm thử có trong cơ sở cho trường hợp kiểm thử đối với các vùng lãnh thổ mà bạn muốn xác thực giải pháp (định dạng: PDF hoặc PNG)
- Giao dịch vận chuyển của ba trường hợp kiểm thử, mỗi giao dịch tương ứng với một loại hình ảnh nhãn: PDF, PNG và ZPL. (định dạng: tệp yêu cầu/phản hồi JSON)
Tuân thủ các phương thức tối ưu sau đây để tránh chậm trễ trong quá trình xử lý:
- Nhãn phải được in và quét với độ phân giải tối thiểu là 600 DPI.
- Đối với máy in nhiệt, phải yêu cầu loại hình ảnh của nhãn phù hợp với mẫu máy in. Ví dụ: ZPLII cho máy in Zebra.
- Các lô hàng FedEx International Express® phải đính kèm nhãn Vận đơn hàng không (AWB) phụ/thứ cấp.
- Lô hàng nhiều kiện (MPS) phải đính kèm một nhãn cho mỗi gói hàng trong lô.
Bước 4: Xem xét việc đánh giá nhãn
Đội ngũ Xác thực sẽ đánh giá và phê duyệt hoặc từ chối tài liệu bạn gửi. Đội ngũ Xác thực sẽ liên hệ với bạn để thông báo về việc phê duyệt hoặc từ chối tài liệu bạn gửi. Nếu tài liệu được phê duyệt, hãy chuyển sang bước tiếp theo. Nếu tài liệu bị từ chối, hãy sửa các giao dịch, màn hình và/hoặc nhãn theo hướng dẫn và gửi lại để được phê duyệt.
Bước 5: Kích hoạt ứng dụng
Sau khi đội ngũ Chứng thực phê duyệt tất cả các nội dung bạn gửi để sang trạng thái sản xuất, họ sẽ ủy quyền thông tin xác thực sản xuất của bạn để gửi giao dịch nhãn vận chuyển đã xác định và thông báo cho bạn qua email khi chứng thực thành công. Quy trình phê duyệt được thực hiện cho từng dự án.
Bước 6: Làm theo hướng dẫn sau xác thực
Xem xét hướng dẫn sau xác thực và làm theo nếu cần.
