Hướng dẫn xác thực - Tourwell Open APIs

API Tourwell hỗ trợ hai phương thức xác thực: qua Bearer Token trong header và api_token trong query string. Dưới đây là cách sử dụng từng phương thức.

I. Hướng dẫn lấy Token

Đăng nhập vào hệ thống truy cập vào Cấu hình > Quản lý tài khoản.

📌

Tại danh sách tài khoản Click xem chi tiết tài khoản có tên Api Official hoặc email api@admin.com Để lấy thông tin Token

II. Xác thực Authorization

1. Xác thực qua Bearer Token
Để sử dụng phương thức xác thực này, người dùng cần thêm Bearer Token vào Authorization header trong mỗi request API

Cấu trúc của request
URL: https://yourdomain.com/endpoint
Header:

Ví dụ Request

Phản hồi thành công
Khi xác thực thành công, API sẽ trả về thông tin liên quan đến request. Ví dụ:

Phản hồi khi không có quyền truy cập (Unauthorized)
Nếu Bearer Token không hợp lệ hoặc không được cung cấp, API sẽ trả về lỗi như sau:

2. Xác thực qua api_token trên Query String
Người dùng có thể lựa chọn cách truyền api_token trực tiếp trong query string khi không tiện gửi qua header.

Cấu trúc của request

Ví dụ Request

Phản hồi thành công
Khi xác thực thành công qua api_token, API sẽ trả về thông tin giống như khi xác thực bằng Bearer Token:

Phản hồi khi không có quyền truy cập (Unauthorized)
Nếu api_token không hợp lệ hoặc không được cung cấp, API sẽ trả về lỗi như sau:

3. Lưu ý về Bảo mật

Token Cần được Bảo Mật: Đây là token không có thời gian hết hạn nên Khuyến nghị không chia sẻ token. Token là mã bảo mật, nếu rò rỉ sẽ gây nguy cơ thất thoát dữ liệu.

Hết hạn Token: Đây là token không có thời gian hết hạn.Nếu cần reset lại Token thì xem hướng dẫn tại bước Hướng dẫn lấy Token

4. Mã lỗi xác thực

Dưới đây là các mã lỗi phổ biến mà API có thể trả về liên quan đến xác thực:

401 Unauthorized: Token không hợp lệ hoặc không được cung cấp.

403 Forbidden: Bạn không có quyền truy cập vào tài nguyên yêu cầu.