Hướng dẫn EasyCargo API (Phần 2)
Như đã đề cập trong phần đầu, hôm nay chúng ta sẽ tìm hiểu EasyCargo API từ góc độ thực tiễn hơn. Để minh họa, chúng tôi sẽ sử dụng API Client của mình, đồng thời kiểm tra hoạt động của API thông qua công cụ trực tuyến ReqBin – một nền tảng cho phép giao tiếp với máy chủ web để tải xuống dữ liệu cần thiết từ phần mềm EasyCargo của chúng tôi.
Việc kiểm thử là một chuyện, nhưng trong thực tế, bạn có thể sử dụng: Java plugin tích hợp vào phần mềm hiện có – Javascript để gọi API từ hệ thống SAP. Chúng tôi sẽ đề cập chi tiết về những phương pháp này, cùng với nền tảng Make và các ví dụ ứng dụng API khác trong phần tiếp theo của loạt bài.
Xem cách yêu cầu trên được thực hiện trong công cụ ReqBin
Hình ảnh trên minh họa quá trình kết nối API của chúng tôi dành cho EasyCargo. Để có thể gửi bất kỳ request (yêu cầu) API nào đến máy chủ web, trước tiên trình kết nối cần được xác thực. Do đó, yêu cầu khởi động sẽ là POST https://go.easycargo3d.com/api/v1/authentication kèm theo tên người dùng và khóa API. Phản hồi từ máy chủ sẽ trả về một token xác thực. Mọi yêu cầu API tiếp theo (trừ khi có quy định khác) cần được xác minh bằng cách thêm token đã nhận vào phần tiêu đề (header). Lưu ý rằng tất cả yêu cầu API đều được thực hiện dưới danh nghĩa chủ sở hữu token. Cả yêu cầu và phản hồi đều phải được định dạng JSON hoặc XML.
Chúng ta đã hoàn tất quá trình xác thực, giờ hãy chuyển sang những tính năng thú vị hơn của API. Giả sử người dùng X có các lô hàng sau được lưu trong tài khoản của họ:
Chúng tôi sẽ minh họa các yêu cầu API thông qua những lô hàng này, vì chúng là một trong những thành phần quan trọng nhất của EasyCargo. Các yêu cầu khác như quản lý người dùng cũng được xây dựng tương tự, vì vậy chúng tôi tin rằng sau khi đọc bài viết này, bạn sẽ dễ dàng xử lý các yêu cầu tương tự một cách thuần thục.
Trong tài liệu API dành cho EasyCargo, mọi phương thức của giao diện lập trình đều được mô tả và giải thích chi tiết. Nếu bạn có bất kỳ câu hỏi nào, đừng ngần ngại liên hệ với chúng tôi!
Yêu cầu API về lô hàng
Từ tài liệu API, chúng ta có thể biết được rằng bằng cách sử dụng các yêu cầu được định dạng chính xác, chúng ta có thể lấy từ máy chủ: Danh sách tất cả các lô hàng, thông tin chi tiết về một lô hàng cụ thể trong tài khoản EasyCargo và thậm chí có thể tạo mới hoặc xóa lô hàng khỏi tài khoản.
Lấy danh sách tất cả các lô hàng
Xem cách yêu cầu trên được thực hiện trong công cụ ReqBin
Lấy thông tin chi tiết một lô hàng cụ thể
Xem cách yêu cầu trên được thực hiện trong công cụ ReqBin
Tạo lô hàng chi tiết
Xem cách yêu cầu trên được thực hiện trong công cụ ReqBin
Như bạn có thể thấy, lô hàng mới đã được tạo thành công và tự động lưu vào tài khoản EasyCargo của bạn.
Trong ứng dụng, bạn có thể dễ dàng mở và xử lý lô hàng mới.
Xoá lô hàng
Xem cách yêu cầu trên được thực hiện trong công cụ ReqBin
Yêu cầu xóa lô hàng đã được xử lý thành công. Lô hàng tương ứng hiện không còn tồn tại trong tài khoản EasyCargo của bạn.
Vài điều cần biết thêm về API
- Số lượng yêu cầu API của bạn bị giới hạn theo thời gian (tối đa 60 yêu cầu/giờ). Hạn mức này được kiểm soát theo khung thời gian trượt, nghĩa là chỉ một số lượng yêu cầu nhất định được cho phép trong một khoảng thời gian xác định.
- Lỗi API được trả về thông qua mã trạng thái HTTP tiêu chuẩn. Trong hầu hết trường hợp, phần nội dung phản hồi sẽ chứa thông báo cụ thể về nguyên nhân lỗi.
- API không thể tự động tính toán kế hoạch bốc xếp cuối cùng.
Người dùng cần đăng nhập vào EasyCargo và nhấn nút “Chất hàng” để thực hiện bước này. - Client API của bạn phải hỗ trợ: truy cập và chỉnh sửa header của yêu cầu/phản hồi và phân tích dữ liệu dưới dạng JSON hoặc XML.
- Để xử lý bước cuối kế hoạch xếp hàng, người dùng API phải đăng nhập vào EasyCargo.
- Một số phương thức API hỗ trợ sử dụng tham số tùy chọn như “from”. Ý nghĩa của từng tham số được mô tả trong tài liệu. Bạn có thể sử dụng các tham số này khi yêu cầu danh sách các lô hàng cần thiết. Các tham số được thêm vào URL sau dấu “?” và phân cách bằng ký tự “&” theo định dạng tên=giá trị, ví dụ: https://go.easycargo3d.com/api/v1/shipments?from=2020-01-02&offset=0&limit=100.
Như bạn có thể thấy, API thực sự là công cụ rất hữu ích. Bài viết này là phần thứ hai trong loạt bài về API EasyCargo, nếu bạn chưa đọc phần đầu tiên, có thể xem tại đây. Trong phần ba, chúng tôi sẽ chia sẻ những lợi ích khi sử dụng API và minh họa bằng một số ví dụ thực tế.
