Tài liệu API

Scope

Scope là một quyền ứng dụng của bạn xin. Đơn vị vận tải, hoặc người dùng, duyệt nó; API khi đó cho ứng dụng làm đúng việc đó và không hơn.

Danh mục scope

Scopeđọc/ghiLoại cấp quyềnMô tảThao tác
trips:readđọcclient_credentialsauthorization_codeĐọc chuyến đi, kèm tuyến, tài xế, phương tiện, điểm dừng, tiến độ và số hành khách.
trips:writeghiclient_credentialsauthorization_codeTạo, sửa, hủy và dời lịch chuyến, phân tài xế và phương tiện, ghi lại các điểm dừng của chuyến. Không có xóa. Quản trị viên của đơn vị phải duyệt.
6 thao tác
routes:readđọcclient_credentialsauthorization_codeĐọc tuyến và mức sẵn sàng của tuyến.
drivers:readđọcclient_credentialsauthorization_codeĐọc tài xế.
vehicles:readđọcclient_credentialsauthorization_codeĐọc phương tiện.
stops:readđọcclient_credentialsauthorization_codeĐọc điểm dừng.
webhooks:manageghiclient_credentialsTạo, sửa, bật, tắt, xóa và gửi thử subscription webhook của ứng dụng, đổi khóa bí mật và đọc nhật ký gửi. Chỉ đọc những gì ứng dụng của bạn sở hữu. Chỉ dùng với token client credentials. Quản trị viên của đơn vị phải duyệt.Cũng đọc subscription và nhật ký gửi của chính ứng dụng của bạn.
14 thao tác
offline_accessgiao thứcauthorization_codeCho phép luồng authorization code trả về refresh token. Không mở dữ liệu nào.không có

Scope hoạt động thế nào

  • Đọc và ghi. Scope *:read đọc dữ liệu. trips:write và webhooks:manage thay đổi dữ liệu: chúng nhạy cảm và quản trị viên của đơn vị phải duyệt. webhooks:manage cũng đọc subscription của chính bạn để quản lý chúng; trips:write không mở đường dẫn đọc nào, nên hãy xin cả trips:read.
  • Scope là giới hạn trên. Token mang các scope của ứng dụng, thu hẹp theo những gì đơn vị đã chấp nhận (và với token người dùng, theo những gì người đó được làm). Lượt cài bị thu hẹp có hiệu lực từ yêu cầu kế tiếp.
  • Hoàn toàn không với tới. Thanh toán, quản lý người dùng và vai trò, quản trị nền tảng không thuộc scope nào. Không thể xóa chuyến và không thể ghi điểm danh hành khách qua API.
  • offline_access chỉ xin refresh token. tenant:connect dành cho ứng dụng đối tác: cho phép client_credentials chạy trong các tenant đã cài, và không bao giờ nằm trong access token.
  • Hãy xin tập nhỏ nhất. Đơn vị vận tải thấy từng scope bằng lời thường và có thể bỏ chọn bất kỳ scope nào.