Bắt đầu

Cung cấp các thông tin cơ bản để nhà phát triển có thể bắt đầu sử dụng API.

Các khái niệm cơ bản

• API Endpoint: Đường dẫn (URL) đầy đủ có thể sử dụng để call một API. API endpoint = https://{API host}/{API path}

• API Version: Phiên bản API đang sử dụng, được đặt sau API Endpoint

  • https://{API host}/{API path}/v1

  • https://{API host}/{API path}/v2

• API host: Phần URL chung của tất cả các API.

• API path: Phần URL riêng của mỗi API, các API khác nhau có API path khác nhau.

• Access Token: Mã xác thực mỗi truy vấn API mà Agilearn đã cung cấp.

• Thành công: Việc call API thành công khi kết quả trả về cùng HTTP code 200.

• Thất bại: Việc call API thất bại khi kết quả trả về cùng HTTP code >= 400.

API host môi trường Product

Môi trường Product là môi trường chính thức mà dịch vụ Agilearn hoạt động. Sau đây là địa chỉ API host trên môi trường product:

https://api.agilearn.app 

Xác thực

Để gửi request call một API, Request Header của bạn phải có các thông tin sau:

• Accept: application/json

• Content-Type: application/json

• Authorization: {access token}

Ví dụ một Request Header:

• Với access token là: 5u84938uwqeir09439045231

• Vậy Header truyền lên sẽ là:

  • Accept: application/json

  • Content-Type: application/json

  • Authorization: 5u84938uwqeir09439045231

Tham số đầu vào

Tham số đầu vào các API của Agilearn có dạng

• Query parameters: https://{API host}/{API path}?{query_param_1}={value_1}&{query_param_2}={value_2}

Kết quả trả về từ API

JSON

Tất cả API Agilearn trả về với định dạng JSON

HTTPCode

API trả về mã HTTP theo các trường hợp thành công. 200 với các trường hợp thành công và từ 400 trở lên với các trường hợp thất bại. Bạn có thể tham khảo danh sách các HTTP Code tại đây

Lỗi

Khi có lỗi, Shippo trả nội dung có cấu trúc như sau:

{
    "status": false, // trạng thái call API thất bại
    "message": "", // thông điệp của lỗi
    "reason": "" // nguyên nhân gây ra lỗi
}

Định dạng dữ liệu thời gian

Hệ thống Agilearn sử dụng giờ GMT và sẽ trả về các thông tin thời gian với múi giờ này. Nhà phát triển chú ý đổi sang múi giờ trên hệ thống của Shop.

Ví dụ: Thời gian tạo khóa học được hiển thị như sau: 2020-12-27T17:00:00.000Z