Diễn Đàn Andy Toàn
API Documentation

Giới thiệu API

Nội dung API này cho phép phần mềm bên ngoài dễ dàng kết nối thông tin đến diễn đàn Andy, bao gồm: nhóm, chủ đề, bài đăng thông tin người dùng, v.v..., Chủ đề (diễn đàn, tác giả cụ thể), Nhóm (thành viên), v.v...

Hiện tại, không có giới hạn tốc độ cũng như yêu cầu xác thực để truy cập API, nhưng theo kế hoạch là mọi Phần mềm phải được xác thực bởi một phần mềm riêng tư và duy nhất Khóa API, phải được miêu tả và xác thực trong mỗi yêu cầu tiêu đề trong tương lai gần (các cập nhật tiếp theo).

Dự án này vẫn đang được phát triển và do đó có thể thiếu một số nội dung và tùy chọn, đặc điểm kỹ thuật này không chỉ được sử dụng làm tài liệu tham khảo mà còn là kế hoạch cho các tính năng sắp tới.

ĐƯỜNG DẪN MẶC ĐỊNH API
https://webhost.andytoan.vn/api/

Chứng thực

Chứng thực có thể được yêu cầu đối với một số điểm cuối, điều này sẽ được chỉ định khi cần thiết. Khóa API là một chuỗi được tạo ngẫu nhiên, được bao gồm trong tất cả các yêu cầu yêu cầu cần xác thực.

Để đưa khóa API vào một yêu cầu, hãy thêm tiêu đề API-KEY vào yêu cầu chứa khóa API.

Chứng thực có điểm cuối của riêng người dùng, có thể được sử dụng để kiểm tra xem có người dùng nào tồn tại với khóa API nhất định hay không. Điều này cho phép phần mềm xác thực người dùng bằng khóa API thay vì Tên người dùng và Mật khẩu.

Tùy thuộc vào phần mềm bên ngoài để khóa việc sử dụng hệ thống của họ đến người dùng cụ thể, điều này có thể được thực hiện bằng "danh sách trắng" trên IP hoặc bằng cách triển khai khóa GUID hoặc SID và lưu trữ thông tin đăng nhập trong cơ sở dữ liệu hoặc bộ lưu trữ của riêng họ.






KHÓA API
API-KEY: 22f29bcb-95bd7a92-f91ce791-82069





PHƯƠNG THỨC TRUY CẬP
https://webhost.andytoan.vn/api/users.php





KẾT QUẢ TRẢ VỀ
{
    "id": 1,
    "username": "John Doe",
    "avatar": "images/default_avatar.png",
    "usergroup": 4,
    "additionalgroups": [
        "3"
    ],
    "displaygroup": 0,
    "usertitle": "Fantastic Poster",
    "away": false,
    "awayreason": "",
    "referrer": 0,
    "timeonline": 21336,
    "warningpoints": 0
}

NGƯỜI DÙNG

Người dùng cuối có thể truy xuất và tìm kiếm người dùng bằng id hoặc bằng tên người dùng của họ. Hiện tại cả hai phương thức tìm kiếm so sánh là chính xác, nếu bạn cần tìm kiếm người dùng, bạn có thể sử dụng tham số tìm kiếm.

Một trong hai tham số phải tồn tại và nếu có nhiều tham số thì chỉ một tham số sẽ được sử dụng sau khi ưu tiên. (ID = Cao, Tên = Trung bình, Tìm kiếm = Thấp)


Phương thức

GETid
ID duy nhất của người dùng
GETname
Tên đăng nhập của người dùng
PHƯƠNG THỨC TRUY CẬP
https://webhost.andytoan.vn/api/users.php





KẾT QUẢ TRẢ VỀ
{
    "id": 1,
    "username": "John Doe",
    "avatar": "images/default_avatar.png",
    "usergroup": 4,
    "additionalgroups": [
        "3"
    ],
    "displaygroup": 0,
    "usertitle": "Fantastic Poster",
    "away": false,
    "awayreason": "",
    "referrer": 0,
    "timeonline": 21336,
    "warningpoints": 0
}

CHỦ ĐỀ

Phương thức cho phép thực hiện lấy thông tin nội dung của chủ đề.

Chủ đề được truy xuất sẽ được phân trang (tự động nhưng không bao gồm thông số ID), số lượng của mỗi trang được thiết lập trên 10 kết quả tìm kiếm.


Phương thức

GETid
ID duy nhất của chủ đề
GETfid
ID Forum để tra cứu
GETpage
Số trang của chủ đề
PHƯƠNG THỨC TRUY CẬP
https://webhost.andytoan.vn/api/threads.php





KẾT QUẢ TRẢ VỀ
{
    "id": 8,
    "subject": "Hello World",
    "fid": 2,
    "uid": 1,
    "author": "admin",
    "views": 1,
    "replies": 0,
    "closed": false,
    "sticky": false,
    "createdAt": 1651180770,
    "post": {
        "id": 22,
        "tid": 8,
        "fid": 2,
        "uid": 1,
        "author": "admin",
        "subject": "Hello World",
        "message": "This thread is the first of it's kind! Hello World!"
    }

BÀI VIẾT

Phương thức cho phép thực hiện lấy thông tin nội dung của bài viết.

Trong trường hợp có nhiều thông số được đưa vào, thông số phù hợp nhất sẽ được chọn, ngay cả khi nó không có kết quả. (ID = Cao, FID = Trung bình, TID = Thấp)

Đối với phản hồi api về sẽ được phân trang (tự động nhưng không bao gồm thông số ID), số lượng của mỗi trang được thiết lập trên 10 kết quả tìm kiếm.


Phương thức

GETid
ID duy nhất của bài viết
GETfid
ID Forum để tra cứu bài viết
GETtid
ID chủ đề để tra cứu bài viết
GETpage
Trang cần tra cứu
PHƯƠNG THỨC TRUY CẬP
https://webhost.andytoan.vn/api/posts.php





KẾT QUẢ TRẢ VỀ
{
    "id": 22,
    "tid": 8,
    "fid": 2,
    "uid": 1,
    "author": "admin",
    "subject": "Hello World",
    "message": "This thread is the first of it's kind! Hello World!"
}