Chuyển đến nội dung
Afi Planner
Tiếng Việt
Bắt đầu dùng thử

Kết nối hệ thống theo hai chiều

Đơn hàng chảy vào từ cửa hàng hoặc ERP của bạn, và mọi diễn biến của chúng chảy ngược lại: đã lên tuyến, đang giao, đã giao kèm chữ ký, ETA mới. REST API và webhook có ký xác thực, dành cho mọi công ty trong Cài đặt → API key.

Bắt đầu dùng thửĐọc hướng dẫnHướng dẫn tích hợp API
Cài đặt → API key trong Afi Planner: một API key, một endpoint webhook và các lần gửi gần đây

Thôi gửi qua gửi lại file CSV

Tạo hoặc cập nhật đơn từ hệ thống của bạn, từng đơn một hoặc tới 1.000 đơn mỗi request, trong giới hạn số điểm giao mỗi kế hoạch của gói (500 với bản dùng thử miễn phí). Gửi lại cùng một mã đơn sẽ cập nhật đơn đó thay vì tạo trùng, cho đến khi tài xế đã làm đơn; từ đó dùng PATCH để sửa các trường.

Biết ngay khi đơn được giao

Webhook báo cho hệ thống của bạn khi đơn được lập tuyến, bắt đầu giao, đã giao hoặc không thành công, kèm lý do, ảnh và chữ ký, và cả khi khách chọn ngày khác, đổi hướng dẫn hay đánh giá lần giao.

Cùng quy tắc với ứng dụng

Đơn gửi qua API được kiểm tra, lập tuyến và giới hạn y hệt như đơn do điều phối viên nhập.

REST API cho cả ngày giao hàng

Mọi việc điều phối viên làm trong ngày đều tự động hóa được: thêm đơn, chọn tài xế làm việc, lập tuyến, gửi tuyến cho tài xế, rồi đọc trạng thái của từng đơn.

  • Đơn hàng: tạo, cập nhật theo mã đơn của bạn, nhập hàng loạt, tạm giữ, mở lại, huỷ kèm lý do (đơn vẫn còn, với ai huỷ và lúc nào), xoá đơn nhập nhầm, và giao lại một đơn không thành công (lần giao tiếp theo, cùng liên kết theo dõi)
  • Hướng dẫn của khách từ trang thanh toán của bạn (customerNote, leaveAtDoor), và notifyCustomer: false cho khách không muốn nhận tin nhắn
  • Lập tuyến: bắt đầu tối ưu và theo dõi job cho đến khi tuyến sẵn sàng
  • Điều phối: gửi tuyến, hoặc những thay đổi kể từ lần gửi trước, đến điện thoại tài xế
  • Đọc dữ liệu: tuyến của từng đơn đúng như đã gửi cho tài xế, với thứ tự điểm giao và ETA (kèm draftRoute khi bảng tuyến của điều phối viên khác với bản đã gửi), ETA trực tiếp, lịch sử trạng thái, liên kết bằng chứng giao hàng và mọi lần giao của đơn
  • Một kế hoạch mỗi ngày: đơn mới và các endpoint theo ngày (tài xế, lập tuyến, điều phối, kế hoạch) dùng kế hoạch đầu tiên của ngày
  • Idempotency key để gửi lại an toàn, và bản mô tả OpenAPI 3.1 cho các công cụ sinh code

Webhook đáng tin cậy

Mỗi sự kiện được ký bằng HMAC-SHA256 kèm dấu thời gian, nên máy chủ của bạn có thể kiểm tra nó thực sự đến từ Afi Planner. Lần gửi không thành công được thử lại trong khoảng một ngày, và mọi lần thử đều hiện trong nhật ký gửi kèm payload, header, câu trả lời của máy chủ bạn, bộ lọc và nút Gửi lại.

  • order.created, order.updated, order.status_changed, order.loaded (tài xế xác nhận đã xếp đơn lên xe khi kiểm hàng), order.eta_changed, order.cancelled (kèm lý do), order.deleted
  • order.rescheduled_by_customer (khách chọn ngày khác trên trang theo dõi), order.instructions_changed, order.rated, order.not_attempted (ngày làm của tài xế đã kết thúc mà đơn vẫn chưa giao), order.moved_back (đơn đã dời sang ngày khác trở lại chỗ cũ)
  • plan.optimized, plan.job_failed, route.dispatched
  • “Gửi thử” và “Gửi lại ngay” ngay trong Cài đặt
  • Sự kiện phát sinh khi endpoint đang tắt không được giữ lại: hãy đọc lại đơn sau khi bật lại
  • Endpoint phải là địa chỉ HTTPS công khai
Endpoint webhook với một lần gửi thử thành công và danh sách sự kiện gần đây

Xây dựng cho vận hành thực tế

API key do chủ tài khoản hoặc thành viên có quyền Nhà phát triển tạo và thu hồi, và chỉ hiện một lần. Key có thể chỉ đọc, có hạn dùng, và có thể đổi key mới trong khi key cũ vẫn chạy thêm 1 hoặc 24 giờ. Key hành động với quyền của người tạo, nên không bao giờ làm được nhiều hơn người đó. Mỗi key được gửi 600 request mỗi phút. Liên kết bằng chứng giao hàng hết hạn sau một giờ. Giới hạn gói và tài khoản tạm dừng hoặc đã kết thúc được áp dụng y hệt như trong ứng dụng.

Công cụ cho lập trình viên trong Cài đặt → Nhà phát triển

Lập trình viên của bạn có thể thử toàn bộ kết nối trước khi viết dòng code nào, và xem lại mọi lần gọi sau đó.

  • Thử key này: các request có sẵn (kiểm tra key, đơn hôm nay, tạo và đọc một đơn thử) hoặc request của riêng bạn, kèm câu trả lời, mã trạng thái, thời gian và lệnh curl để sao chép
  • Nhật ký request API: mọi lần gọi API trong 3 ngày, với mã trạng thái, key, mã đơn và nội dung request lẫn câu trả lời, đã bỏ các thông tin bí mật
  • Bộ Postman làm riêng cho công ty bạn: múi giờ, kho và các đơn mẫu theo đúng kiểu mã đơn của bạn, từ kiểm tra key đến webhook
  • Đơn thử: đơn có mã bắt đầu bằng API-TEST- không bao giờ được lập tuyến, đưa lên tuyến hay nhắn tin cho khách, không tính vào mức sử dụng và phân tích, và bị xóa sau 3 ngày; webhook của nó mang test: true

Hướng dẫn từng bước

7 bước · 7 phút đọc

Kết nối hệ thống bằng API và webhook

Câu hỏi thường gặp về tính năng này

Câu hỏi thường gặp

Tôi có cần lập trình viên không?

Có, kết nối qua API hoặc webhook cần một lập trình viên hoặc đối tác tích hợp. Trong lúc đó đội của bạn vẫn có thể nhập bảng tính trong ứng dụng như bình thường.

Có ứng dụng cho Shopify hoặc Zapier không?

Chưa có. Hiện tại bạn kết nối chúng qua API và webhook. Hãy liên hệ với chúng tôi nếu bạn cần một connector có sẵn.

API có tính thêm phí không?

Không. API và webhook có trong mọi gói, kể cả bản dùng thử miễn phí.

Thêm tính năng

Lập tuyến ngày mai chỉ trong 3 phút

Bắt đầu dùng thử miễn phí 3 tháng. Không cần thẻ tín dụng, không cần cuộc gọi thiết lập, không cần cài đặt.

Bắt đầu dùng thửLiên hệ kinh doanh