Bỏ qua đến nội dung

Tài liệu kỹ thuật

Tích hợp LRS trong một buổi chiều.

Xác thực & API key

Yêu cầu tới dữ liệu của tổ chức cần API key gửi qua header Authorization. Khoá gắn với một tổ chức và chỉ làm được những việc thuộc scope đã cấp.

EndpointPOSThttps://api.lrsvn.com/v1/api-keys

API key có dạng lrs_…. Gửi khoá trong header Authorization: Bearer — cổng API chỉ nhận đúng dạng này (header khác, kể cả token phiên đăng nhập, bị từ chối 401). Khoá chỉ dùng được cho tổ chức đã tạo ra nó, nên không cần (và không thể chọn) tổ chức khác qua X-Organization-ID.

Yêu cầu

Tạo khoá trong bảng điều khiển (Cài đặt → API) bằng tài khoản Owner hoặc Admin. Endpoint này cần phiên đăng nhập trên website (https://lrsvn.com/api/v1/api-keys), không gọi được qua cổng API; cũng không thể dùng một API key để tạo hay quản lý API key khác.

JSON
{
  "name": "Game server production",
  "scopes": ["anticheat:ingest", "anticheat:read"],
  "expires_at": "2027-09-30T00:00:00Z"
}

Tham số

Tham sốKiểuMô tả
namestringTên gợi nhớ, 2–200 ký tự.
scopesstring[]1–32 scope khác nhau, dạng resource:read, resource:write, resource:ingest, resource:* hoặc *.
expires_atstringKhông bắt buộc. Thời điểm hết hạn theo RFC 3339 (phải ở tương lai); bỏ trống nếu không hết hạn.

Phản hồi

HTTP
HTTP/1.1 201 Created

{
  "id": "key_7f3a9c2e5b",
  "key": "lrs_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "prefix": "lrs_Zk3vN8qT",
  "scopes": ["anticheat:ingest", "anticheat:read"],
  "expires_at": "2027-09-30T00:00:00Z"
}

Khoá đầy đủ (key) chỉ hiện một lần. Hãy lưu vào kho bí mật của hệ thống — LRS chỉ giữ giá trị băm và prefix (12 ký tự đầu) để bạn nhận ra khoá trong danh sách.

Gọi API bằng khoá

cURL
curl "https://api.lrsvn.com/v1/anticheat/events?action=ban" \
  -H "Authorization: Bearer $LRS_API_KEY"

Scope

ScopeCho phép
anticheat:readĐọc sự kiện, luật, lịch sử người chơi; kết nối WebSocket; lấy thông tin SDK.
anticheat:ingestGửi sự kiện phát hiện và nhịp "đang online" của người chơi.
anticheat:writeXử lý sự kiện (cảnh báo, cấm, bỏ qua) và sửa luật.
organization:writeQuản lý webhook của tổ chức.
*Toàn quyền. * và resource:* chỉ Owner mới cấp được.

Xoay vòng và thu hồi

  • POST /api-keys/{id}/rotate cấp khoá mới cho cùng cấu hình; khoá cũ mất hiệu lực ngay.
  • DELETE /api-keys/{id} thu hồi khoá.
  • GET /api-keys liệt kê khoá (không bao giờ trả lại giá trị khoá) kèm last_used_at để tìm khoá không còn dùng.

Các thao tác quản lý khoá yêu cầu phiên đăng nhập của Owner hoặc Admin trên website (bảng điều khiển hoặc https://lrsvn.com/api/v1).

Mã lỗi

HTTPMãKhi nào
400invalid_requestScope sai định dạng hoặc trùng, hoặc expires_at không ở tương lai.
401unauthorizedKhoá không hợp lệ, đã thu hồi hoặc hết hạn.
403scope_deniedKhoá không có scope cần cho thao tác này.
403organization_deniedX-Organization-ID khác tổ chức của khoá.
403forbiddenAdmin cố cấp scope * hoặc resource:* (chỉ Owner cấp được).
422validation_errorname ngoài khoảng 2–200 ký tự.