Tài liệu API

Tìm hiểu cách kết nối và tích hợp với API của chúng tôi.

Nhận khóa API của riêng bạn

URL cơ sở

Xác thực

Tất cả các điểm cuối API đều yêu cầu khóa API được gửi bằng phương thức Xác thực Bearer.

Authorization: Bearer {api_key}

Ví dụ

curl --request GET \
--url 'https://mybotsy.com/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

Lỗi

API của chúng tôi sử dụng mã trạng thái HTTP thông thường để cho biết yêu cầu thành công hay thất bại.

Ví dụ

{
    "errors": [
        {
            "title": "B\u1ea1n kh\u00f4ng c\u00f3 quy\u1ec1n truy c\u1eadp v\u00e0o API.",
            "status": 401
        }
    ]
}

Mã trạng thái

200 Yêu cầu đã hoàn tất thành công

400 Yêu cầu không hợp lệ - Tham số bắt buộc bị thiếu hoặc không hợp lệ

401 Không được phép - Khóa API bị thiếu hoặc không hợp lệ

404 Không tìm thấy tài nguyên được yêu cầu

429 Quá nhiều yêu cầu - Đã vượt quá giới hạn tốc độ

500 Lỗi máy chủ nội bộ - điều này có nghĩa là có sự cố từ phía chúng tôi

Tất cả kết quả điểm cuối API đều hoạt động với múi giờ UTC trừ khi được chỉ định khác.

Người dùng

Nhóm

Thành viên nhóm

Thành viên của nhóm

Nhật ký tài khoản