Khóa API
Tối ưu tuyến đường dùng cách này. Gửi khóa trong header api-key trên mỗi request. Toàn bộ endpoint tối ưu tuyến trong tài liệu này chỉ nhận khóa API, không nhận token.
api-key: YOUR_KEYTài liệu API
Đây là các nhóm endpoint dành cho đối tác tích hợp. Tài liệu sinh từ bản đặc tả OpenAPI đã chốt phiên bản, không gọi thẳng ra hệ thống vận hành.
Phạm vi tài liệu này
Trang này chỉ công bố các nhóm endpoint dành cho đối tác. Các phần thuộc vận hành nội bộ của hệ thống TMS không nằm trong tài liệu công khai và sẽ không xuất hiện ở đây.
Xác thực
Cách xác thực phụ thuộc vào nhóm endpoint, không phụ thuộc vào khóa của bạn. Trang chi tiết của mỗi endpoint ghi rõ cách nó nhận, ở mục xác thực yêu cầu.
Token JWT
Các nhóm còn lại dùng cách này. Gửi token trong header Authorization theo dạng Bearer. Riêng lập kế hoạch chuyến nhận cả hai.
Authorization: Bearer YOUR_TOKENĐiều kiện để một khóa gọi được tối ưu tuyến
Ba điều kiện phải cùng đúng. Thiếu bất kỳ điều nào thì request bị từ chối, và thông báo trả về nằm trong phần mã lỗi bên dưới.
- Khóa còn hiệu lực, chưa hết hạn.
- Khóa được cấp Quyền dùng API tối ưu tuyến. Quyền này do đội Route4Green cấp cho từng khóa, bạn không tự bật được.
- Tính năng đang được bật ở phía máy chủ. Đây là công tắc chung, không phải thiết lập riêng của từng tài khoản, nên một khóa đủ quyền vẫn có thể bị từ chối.
Không nhúng khóa vào mã chạy phía trình duyệt hay ứng dụng di động. Khóa chỉ dùng ở phía máy chủ của bạn.
Lấy khóa bằng cách nào
Hiện chưa tự lấy được. Khóa được tạo trong cổng đối tác và phải đăng nhập bằng phiên làm việc mới tạo được, nên chưa có đường tự phục vụ cho lập trình viên. Bạn đăng ký dùng thử, chúng tôi cấp khóa thử nghiệm bằng tay nếu bài toán của bạn phù hợp.
Đăng ký dùng thửCổng tự phục vụ và môi trường thử nghiệm đang trong kế hoạch, chưa có ngày phát hành.
Địa chỉ gốc
Chỉ có một địa chỉ máy chủ, được cấp khi bạn nhận khóa. Đường dẫn trong tài liệu này là phần nối sau địa chỉ đó.
Môi trường thử nghiệm và môi trường thật dùng chung địa chỉ đó, phân biệt bằng khóa bạn gửi kèm chứ không bằng đường dẫn khác. Đổi môi trường là đổi khóa, không phải đổi cấu hình địa chỉ.
Nhóm endpoint
8 nhóm
Tối ưu tuyến đường
Tạo job tối ưu, theo dõi trạng thái và lấy kết quả. Đây là nhóm trung tâm của Route4Green.
7 endpoint
Lập kế hoạch chuyến
Tạo và điều chỉnh kế hoạch chuyến theo ngày, gắn xe và tài xế vào chuyến.
6 endpoint
Đơn hàng
Đẩy đơn hàng và điểm giao vào hệ thống để đưa vào bài toán tối ưu.
7 endpoint
Hàng chờ ghép
Gom yêu cầu vận chuyển vào pool để lõi tối ưu quyết định ghép chuyến.
5 endpoint
Phương tiện
Khai báo xe, tải trọng và thuộc tính vận hành của đội xe.
6 endpoint
Kế hoạch xe
Lịch khả dụng của từng xe, để kết quả tối ưu bám đúng đội xe thật.
7 endpoint
Webhook
Đăng ký nhận thông báo khi có sự kiện, thay vì hỏi liên tục.
5 endpoint
Khóa API
Tạo, xem và thu hồi khóa truy cập cho từng hệ thống tích hợp.
3 endpoint
Hướng dẫn và SDK
5 trang
Năm trang hướng dẫn dưới đây viết cho người tích hợp. Bộ SDK đóng gói sẵn đang trong kế hoạch và chưa phát hành, nên mỗi trang chỉ ra cách làm bằng HTTP thuần, thứ dùng được ngay hôm nay.
Cài đặt
Chưa có gói để cài. Sinh client từ bản đặc tả tải về.
Bắt đầu nhanh
Gửi một job và lấy kết quả, từ đầu tới cuối.
Xác thực
Gửi khóa trong header api-key.
Xử lý job bất đồng bộ
Sáu trạng thái, bốn trạng thái kết thúc, và khi nào nên dừng.
Kiểm tra chữ ký webhook
Kiểm tra trước khi tin, và kiểm tra trên phần thân thô.
Về bản đặc tả
Tài liệu này sinh từ một bản đặc tả OpenAPI đã được lưu lại và rà soát, cập nhật lần gần nhất vào ngày dưới đây. Chúng tôi không tự động lấy bản mới, để một endpoint nội bộ mới thêm ở hệ thống gốc không thể vô tình lộ ra đây.
Cập nhật
Tải bản đặc tả dành cho đối tác
Bản JSON dưới đây chứa đúng những endpoint xuất hiện trong tài liệu này, kèm các cấu trúc dữ liệu mà chúng tham chiếu tới. Phần vận hành nội bộ đã được lọc bỏ chứ không chỉ ẩn đi, nên bạn có thể đưa thẳng vào công cụ sinh mã.
Tải file JSON
46 endpoint trong file