API tham chiếu (V2)

Thông tin cần biết

Các thông tin mà bạn cần biết trước khi bắt đầu sử dụng API để tiến hành phát triển ứng dụng của mình.

Các loại Headers cần thiết

  • ISPA-AUTH-KEY: là mã xác thực của ứng dụng, được cấp phát khi đăng ký ứng dụng trên hệ thống CMS.
  • ISPA-AUTH-ID: là ID xác thực của ứng dụng, được cấp phát khi đăng ký ứng dụng trên hệ thống CMS.
  • Authorization: là mã xác thực của người dùng, được cấp phát khi người dùng đăng nhập vào ứng dụng quản trị.

Lưu ý

ISPA-AUTH-KEY và ISPA-AUTH-ID là các thông tin bắt buộc, nếu không có sẽ không thể truy cập vào API. Bạn có thể tự tạo cho riêng mình thông tin và đặt vào file .env của ứng dụng.

Cấu trúc trả về

Cấu trúc trả về tuân theo quy tắc Restful API, bao gồm các thông tin chính sau:

{
    "status": "success|error|failed",
    "message": "...",
    "data": {}
}

Trong đó:

  • data: có thể là một object hoặc một mảng object
  • message: là thông điệp trả về, có thể là một string hoặc một string array

Các loại trạng thái trả về

  • status: success - Thành công
  • status: error - Lỗi
  • status: failed - Thất bại

HTTP Status Code

  • 200: OK
  • 201: Created
  • 400: Bad Request
  • 401: Unauthorized
  • 403: Forbidden
  • 404: Not Found
  • 405: Method Not Allowed
  • 406: Not Acceptable
  • 422: Unprocessable Entity
  • 429: Too Many Requests
  • 500: Internal Server Error
  • 502: Bad Gateway
  • 503: Service Unavailable