1. Tạo dự án để có thông tin xác thực
2. Tích hợp API và thử nghiệm quá trình triển khai
3. Đưa dự án vào giai đoạn sản xuất
4. Hoàn thành chứng nhận

Quản trị viên hoặc người đóng góp cho tổ chức của bạn có thể tạo dự án API bằng cách nhấp vào nút Tạo dự án API.

Trước khi bắt đầu, trước tiên bạn cần cung cấp lý do bạn truy cập API của FedEx. Một hộp thoại sẽ xuất hiện và trình bày các tùy chọn trong danh sách thả xuống. Bạn nên chọn tùy chọn xác định rõ nhất nhu cầu kinh doanh của mình khi tích hợp với API của FedEx.

Nếu bạn là người gửi hàng, bạn có thể bắt đầu tạo dự án của mình. Quy trình bao gồm ba bước:

Chọn API

Chọn các API bạn muốn đưa vào dự án. Dựa trên các API bạn chọn, bạn có thể cần thực hiện thêm một số lựa chọn khác.

Nếu chọn API Theo dõi, bạn cũng sẽ cần phải:

• Chọn số tài khoản để liên kết với khóa sản xuất của bạn.
• Xem lại hạn mức API theo dõi, giới hạn giá cước và chi tiết chứng nhận API.
• Chọn xem bạn có muốn nhận email thông báo khi bạn vượt quá hạn mức giao dịch hay không.

Cấu hình dự án

Nhập một số chi tiết cụ thể của dự án, bao gồm tên và địa điểm vận chuyển.

• Đặt tên dễ nhận biết cho dự án và 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, bạn có thể đặt tùy chọn thông báo của mình.

Xác nhận chi tiết

Xem lại thông tin chi tiết về dự án của bạn, sau đó chấp nhận các điều khoản và điều kiện.

• Đọc và chấp nhận Thỏa thuận cấp phép về FedEx Developer Portal, cũng như xác nhận rằng bạn không có ý định bán hay phân phối ứng dụng của mình.
• Khi 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 thử nghiệm của mình trong dự án mới.

• Yêu cầu mã thông báo truy cập OAuth, là mã bắt buộc với mỗi giao dịch API. Mã thông báo này chỉ có hiệu lực trong một giờ, do đó 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
• Nhấp vào Tài liệu bất kỳ về API của bạn để đọc ngữ cảnh kinh doanh cho từng API, qua đó hiểu rõ nhất về cách sử dụng API đó. 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.
• Thực hiện lệnh gọi đến các điểm cuối này như mô tả trong ví dụ, cấu hình lệnh gọi bằng thông tin xác thực thử nghiệm của bạn.
• 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.
• Thử nghiệm quá trình triển khai trong môi trường thử nghiệm của FedEx bằng thông tin xác thực thử nghiệm và URL thử nghiệm FedEx.

Trong bước Cấu hình dự án:

• Bạn có thể đổ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.

Trong bước Nhận khóa dự án:

• Khóa API sản xuất và Mã khóa bí mật sản xuất của bạn sẽ hiển thị. Nhớ sao chép các khóa này vào nơi an toàn.
• Để đảm bảo an toàn cho mã khóa bí mật sản xuất của bạn, chúng tôi chỉ hiển thị mã khóa một lần. Nếu để mất, bạn có thể tạo mã khóa mới.
• Nhấp vào Next (Tiếp theo).

Bây giờ, bạn sẽ được đưa trở lại trang Tổng quan về dự án. Tại đây, bạn có thể thêm nhiều tài khoản liên kết với dự án của mình.

Trên trang Tổng quan về dự án:

• Nhấp vào dấu 3 chấm dọc để thêm nhiều tài khoản liên kết với dự án.
• Tiếp đến, hãy nhấp vào Chỉnh sửa.

Thao tác này sẽ đưa bạn đến trang Khóa API để bạn thêm bất kỳ tài khoản nào khác mà bạn muốn liên kết với khóa sản xuất cho dự án này.

1. Một số API yêu cầu chứng nhận nhãn vận chuyển để sử dụng trong môi trường sản xuất của chúng tôi. Hãy hoàn thành quy trình chứng nhận cho bất kỳ API nào trong dự án của bạn có yêu cầu này.

1. Sau khi tất cả API đã được chứng nhận và kích hoạt, hãy cập nhật yêu cầu API của bạn bằng cách thay thế URI, khóa và tài khoản vận chuyển thử nghiệm bằng URI, khóa và tài khoản vận chuyển dùng trong giai đoạn sản xuất.

2. 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.

3. Tận dụng lợi ích do tích hợp mới của bạn mang lại!

Điều kiện tiên quyết để tạo dự án webhook

1. Tạo một URL hợp lệ trong ứng dụng/nền tảng đích của bạn
2. Tạo mã thông báo bảo mật
3. Thử nghiệm URL webhook
4. Xác thực URL đích

Tạo dự án webhook

1. Tạo dự án webhook để nhận thông báo về phần tải đã định cấu hình

Điều kiện tiên quyết để tạo dự án webhook

Tạo một URL hợp lệ trong ứng dụng/nền tảng đích của bạn để nhận mã/tin nhắn xác thực và thông báo theo dõi phần tải webhook từ FedEx.

Yêu cầu về URL:

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 bạn (khách hàng) và FedEx.

Yêu cầu về mã thông báo bảo mật:

• độ dài tối thiểu 25 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ố

Thử nghiệm URL là bước tuỳ chọn mà bạn sẽ thấy hữu ích.

Bước thử nghiệm có thể giúp bạn hiểu rõ hơn liệu URL bạn tạo ở bước 1 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 thử nghiệm còn có thể cung cấp cho bạn dữ liệu thử nghiệm 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 thử nghiệm không xác thực URL của bạn.

Hãy truy cập vào tài liệu webhook để tìm hiểu cách thử nghiệm URL webhook của bạn.

Sử dụng phương pháp hàm băm HMAC SHA256, thiết lập quy trình xác thực để xác thực thông tin được truyền giữa URL đích của bạn và FedEx.

1. Khi bạn nhấp vào Tạo, FedEx sẽ tạo ra một chuỗi thử thách ngẫu nhiên, gửi cho bạn trong phần nội dung yêu cầu. Bạn cần gửi lại chuỗi thử thách này cho FedEx trong phần nội dung phản hồi.

1. Khởi tạo mã xác thực tin nhắn (MAC) bằng thuật toán/quy trình HMAC SHA256 để băm (hoặc kết hợp) chuỗi thử thách và mã thông báo bảo mật (hoặc khóa bí mật) để tạo chữ ký băm

1. Phản hồi FedEx bằng cả challengeString và challengeStringResponse trong nội dung phản hồi, kèm theo mã trạng thái HTTP 200 (OK) hoặc 202 (ACCEPTED).

1. Lúc này, FedEx sẽ xác thực chuỗi thử thách và phản hồi chuỗi thử thách.

• Sau khi nhận được nội dung phản hồi, FedEx sẽ xác thực challengeString và challengeStringResponse (hoặc chữ ký băm được tạo trước đó) bằng cách so sánh với chữ ký challengeString và chữ ký băm tương ứng do FedEx tạo ra.

• Nếu cả chữ ký "challengeString" và HMAC đều khớp thì quá trình xác thực và quy trình làm việc đã thành công. Nếu không, quy trình xác thực sẽ thất bại, và một thông báo lỗi tương ứng sẽ hiển thị.

Tạo dự án webhook

Trên trang Dự án của tôi, vào tab Webhook.

Quản trị viên hoặc người đóng góp cho tổ chức của bạn có thể tạo dự án webhook bằng cách nhấp vào nút Tạo dự án.

Trước khi bắt đầu, trước tiên bạn cần cho chúng tôi biết lý do bạn truy cập webhook của FedEx. Một hộp thoại sẽ xuất hiện và trình bày các tùy chọn trong một danh sách thả xuống. Bạn nên chọn tùy chọn xác định rõ nhất nhu cầu kinh doanh của mình khi tích hợp với webhook của FedEx.

Nếu bạn là người gửi hàng, bạn có thể bắt đầu tạo dự án của mình bằng cách hoàn thành các bước sau:

1. Xác định nhu cầu của doanh nghiệp

• Chọn tùy chọn trình bày rõ nhất lý do doanh nghiệp của bạn muốn tích hợp với webhook của FedEx.

1. Chọn bậc và tính năng của bậc

• Chọn bậc webhook cơ bản hoặc nâng cao cho dự án của bạn, dựa trên nhu cầu của dự án.
• Sau này, bạn luôn có thể chỉnh sửa lựa chọn bậc.
• Mỗi bậc có một mức phí đăng ký hằng tháng.

• Chọn các tính năng mà bạn muốn cấu hình cho dự án của mình.
• Sau này, bạn cũng có thể chỉnh sửa tính năng.

1. Cấu hình chi tiết dự án

• Đặt tên dễ nhận biết cho dự án của bạn
• Cung cấp chi tiết URL đích và mã thông báo bảo mật đã tạo trong quá trình xác thực trước khi thiết lập.

Chọn tài khoản

• Chọn trong một danh sách số tài khoản đủ điều kiện (tại Hoa Kỳ hoặc Canada) mà bạn muốn liên kết với dự án của mình.

  5. Xác nhận chi tiết và chấp nhận điều khoản

• Xem lại thông tin chi tiết về dự án được định cấu hình.
• Đọc và chấp nhận Thỏa thuận cấp phép về Developer Portal, cũng như xác nhận rằng bạn không có ý định phân phối ứng dụng của mình.
• Đọc và chấp nhận Thỏa thuận về giá.
• Khi bạn nhấp vào nút Tạo dự án:

1. Nếu yêu cầu tạo của bạn đã được xác thực và xử lý thành công, bạn sẽ được đưa đến màn hình xác nhận.

• Nếu xác thực không thành công hoặc gặp sự cố, bạn sẽ thấy thông báo lỗi.

1. Khi đó, dự án webhook theo dõi của bạn sẽ có ID webhook do hệ thống tạo và hiển thị ở trạng thái "Đang hoạt động".

1. FedEx tạo tổ chức Nhà cung cấp tương thích.
2. Chấp nhận lời mời.
3. Mời người dùng vào tổ chức của bạn.
4. Chọn API cần thiết cho giải pháp của bạn.
5. FedEx tạo (các) dự án.
6. Tích hợp API vào ứng dụng của bạn và chứng nhận đáp ứng Chương trình tương thích.
7. FedEx đưa (các) dự án vào sản xuất.
8. Tạo mã khóa bí mật cho khâu sản xuất.

• 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.
• Sau khi hoàn thành việc chứng nhận và tích hợp, bạn sẽ có thể dễ dàng phân phối giải pháp đến khách hàng.

• Để có quyền truy cập vào công cụ và tài liệu tích hợp API, vui lòng chấp nhận lời mời. Để chấp nhận lời mời, bạn cần đăng nhập bằng ID người dùng FedEx và mật khẩu hoặc tạo mới nếu bạn chưa có thông tin đăng nhập.

• Khi là Quản trị viên, bạn có thể mời bất kỳ thành viên nhóm nào cần quyền truy cập vào dự án hoặc tổ chức. Để biết chi tiết về các vai trò khác, hãy xem Hướng dẫn quản trị tổ chức.

• Nếu tổ chức của bạn đã được tạo, hãy yêu cầu Quản trị viên của tổ chức hoặc FedEx mời bạn tham gia. Bạn sẽ có 24 giờ để chấp nhận lời mời, nhưng nếu bạn bỏ lỡ khoảng thời gian này, bạn có thể yêu cầu họ gửi lại lời mời.

• Truy cập vào Danh mục API để xác định các API phù hợp cho giải pháp của bạn. Bộ phận Hỗ trợ khách hàng về kỹ thuật (CTC) của FedEx và nhân viên quản lý Kênh tương thích có thể hỗ trợ bạn chọn API phù hợp cho giải pháp của bạn theo nhu cầu kinh doanh.

• Chọn API để khám phá nội dung tổng quan, nhật ký thay đổi và các tính năng chính.

• Xem tài liệu về API để khám phá các phần tử yêu cầu và phản hồi, các ví dụ bằng ngôn ngữ mà bạn chọn, các đối tượng lỗi, v.v.

• Quay lại Salesforce để điền vào Bảng thông tin sản phẩm (PIW) và liệt kê API bạn muốn thêm vào giải pháp của mình.

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 trong FedEx Developer Portal. Nếu người dùng không phải là Quản trị viên của tổ chức, họ sẽ cần được mời để xem từng dự án. 

Đây cũng là thời điểm nhóm Tương thích của FedEx cùng với CTC của FedEx và các nhóm chứng nhận sẽ tổ chức buổi minh họa kỹ thuật về API với nhóm của bạn. Nhóm FedEx sẽ thảo luận về các tính năng và chức năng mới có trong phiên bản API mà bạn đang sử dụng. Nhóm sẽ có thể giải đáp các câu hỏi kỹ thuật liên quan đến API, việc thử nghiệm API và tất cả các quy trình cần hoàn thành để bắt đầu quy trình ‘chứng nhận*’ cho API.

* Chứng nhận – Quy trình được Chương trình tương thích của FedEx xác định để đáp ứng các yêu cầu về Tuân thủ chương trình. Chứng nhận chương trình tương thích là yêu cầu bắt buộc để đảm bảo rằng tất cả các Nhà cung cấp tương thích đều triển khai, tiếp thị và phân phối công nghệ FedEx đến người gửi (khách hàng) theo tiêu chuẩn công nghệ & dịch vụ của FedEx.

1. Giờ đây, bạn sẽ có quyền truy cập vào Mã API thử nghiệm và Mã khóa bí mật thử nghiệm để bắt đầu chạy các giao dịch. Truy xuất các mã này từ tab Mã khóa thử nghiệm trong trang Tổng quan về dự án.

1. Để tạo mã khóa khách hàng, bạn sẽ cần sử dụng API Đăng ký thông tin xác thực, vốn là một API riêng tư chỉ có trong phần API ở mỗi dự án của bạn.
2. Sau khi bạn đã tạo một vài mã khóa khách hàng, hãy tiếp tục yêu cầu mã thông báo truy cập OAuth để sử dụng với mọi giao dịch API. Phiên cho mã thông báo chỉ có hiệu lực trong một giờ, do đó 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 API để biết thêm chi tiết. Khi xem mã lập trình 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.

1. Chọn tài liệu cho các API trên trang Mã thử nghiệm và đọc bối cảnh kinh doanh để hiểu rõ nhất cách sử dụng API đã chọn. Xem lại các yêu cầu ví dụ cho điểm cuối phù hợp với nhu cầu tích hợp của bạn.
2. Thực hiện gọi đến các điểm cuối này như mô tả trong yêu cầu ví dụ, cấu hình cho lệnh gọi sử dụng thông tin xác thực thử nghiệm của bạn.
3. Xác minh rằng các phản hồi lệnh gọi API đã nhận khớp với các phản hồi được minh họa trong tài liệu.
4. Thử nghiệm đầy đủ việc triển khai trong môi trường thử nghiệm FedEx bằng thông tin xác thực thử nghiệm và URI thử nghiệm FedEx.
5. Sau khi thử nghiệm đầy đủ các giải pháp của bạn, hãy chứng nhận từng giải pháp trong Salesforce. 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 chứng nhận của bạn được phê duyệt.

• Sau đó, FedEx sẽ đưa (các) dự án vào sản xuất.
• Tiếp đó, bạn sẽ có thể thấy Mã API sản xuất trong tab Mã sản xuất của trang Tổng quan về dự án.

• Bạn phải tạo Khóa bí mật sản xuất bằng cách nhấp vào liên kết Tạo khóa bí mật trong 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.
• Tận dụng lợi ích do tích hợp mới của bạn mang lại!