Chuyển tới nội dung chính

Quick Start

mẹo

Bắt đầu ngay và thực hiện API request đầu tiên để lấy danh sách phương tiện tại đây.

Bắt đầu với Cartrack Fleet API rất đơn giản. Phần này cung cấp ví dụ cơ bản để thực hiện API call đầu tiên. Dù ví dụ sử dụng curl, một công cụ linh hoạt và phổ biến để gửi HTTP request từ command line, quý khách có thể áp dụng cùng nguyên tắc cho các ngôn ngữ và công cụ khác như Python, JavaScript hoặc bất kỳ HTTP client library nào.

Điều kiện tiên quyết​

Trước khi tiếp tục, vui lòng đảm bảo quý khách có:

  • cURL đã cài đặt: Đảm bảo cURL đã được cài đặt trên hệ thống của quý khách. cURL thường có sẵn trên Unix, Linux, macOS và có thể cài trên Windows.
  • Base URL và Authentication Credentials: Quý khách cần base URL của Cartrack Fleet API và credentials hợp lệ. Để biết chi tiết cách lấy các thông tin này, hãy tham khảo Authentication và Base URLs trong tài liệu.

Thực hiện API Call​

Dưới đây là cách thực hiện API call để lấy danh sách phương tiện bằng curl:

curl --location '{baseUrl}/rest/vehicles' \
--header 'Accept: application/json' \
--header 'Authorization: Basic your_encoded_credentials'

Thay {baseUrl} bằng base URL thực tế được cung cấp cho Cartrack Fleet API, và thay your_encoded_credentials bằng credentials ủy quyền đã mã hóa Base64 của quý khách.

Giải thích command​

  • --location: Yêu cầu curl tự động theo các redirect do server trả về trong quá trình xử lý HTTP request.
  • --header: Dùng để chỉ định header bổ sung cho request. Trong ví dụ này, ta khai báo nhận response ở định dạng JSON và truyền credentials ủy quyền.
  • URL endpoint ({baseUrl}/rest/vehicles) là endpoint API để lấy danh sách phương tiện.

Response​

API sẽ trả về response JSON chứa danh sách phương tiện, mỗi phương tiện có các thông tin như vehicle ID, model và các dữ liệu liên quan khác.

Ví dụ cơ bản này cung cấp khung ban đầu để thực hiện API calls tới Cartrack Fleet API. Quý khách có thể điều chỉnh ví dụ này theo ngôn ngữ hoặc công cụ quý khách chọn dựa trên cùng nguyên tắc. Để biết thêm chi tiết về chức năng API và các endpoint bổ sung, tiếp tục khám phá tài liệu API đầy đủ.

Import vào Postman​

Quý khách có thể import đặc tả OpenAPI của Cartrack vào Postman để tạo sẵn một collection request dùng ngay.

  • Spec URL: https://developer.cartrack.com/openapi/openapi.yaml
  • Trong Postman: nhấp Import → Link, dán URL, sau đó nhấp Import. Hoặc dùng Import → File và tải lên file openapi.yaml đã tải xuống.
  • Postman sẽ tạo collection request dựa trên spec.
  • Cấu hình environment values:
    • Thiết lập base URL theo hướng dẫn trên trang Base URLs.
    • Cấu hình authentication: Cartrack APIs sử dụng Basic Authentication. Trong Postman, mở bất kỳ request nào, vào tab Authorization, chọn Basic Auth, rồi nhập username và password. Hoặc thêm header Authorization với giá trị Basic <base64-encoded-credentials>. Xem trang Authentication để biết chi tiết cách tạo credentials.
  • Chạy từng request hoặc dùng Collection Runner để thực thi nhiều calls.