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.

Bắt đầu với tài khoản và API LRS

Kiểm tra khả năng API, đăng ký tổ chức, chính sách email khi thiếu SMTP và các quy tắc bảo vệ phiên đăng nhập.

EndpointGEThttps://lrs.vn/api/v1/capabilities

LRS cung cấp API JSON qua HTTPS. Hướng dẫn này giúp bạn kiểm tra khả năng hiện có và bắt đầu sử dụng tài khoản; khả năng cung cấp một dịch vụ phụ thuộc vào cấu hình của LRS.

Kiểm tra khả năng trước khi tích hợp

Gọi endpoint công khai để đọc cấu hình hiện tại:

cURL
curl --fail --silent --show-error https://lrs.vn/api/v1/capabilities

Đọc auth.email_verification_required trước khi chọn luồng xác minh email và auth.password_reset_available trước khi mở chức năng khôi phục mật khẩu. Các giá trị trong providers cho biết tích hợp đã được cấu hình; chúng không phải cam kết về thanh toán thành công, cấp tài nguyên hoặc thời gian hoạt động. Khi nhà cung cấp chưa sẵn sàng, thao tác liên quan có thể trả lỗi khả dụng thay vì tạo kết quả giả.

Tạo tài khoản và tổ chức

Bạn có thể đăng ký bằng tên, email, số điện thoại, mật khẩu và đồng ý Điều khoản, sau đó đăng nhập để thực hiện onboarding. Onboarding lưu từng bước: thông tin tổ chức, nhu cầu và lời mời; bạn có thể bỏ qua các bước tùy chọn. Tài khoản khách hàng là chủ tổ chức của mình, không tự có quyền nhân viên quản trị hệ thống.

Email khi chưa cấu hình SMTP

Theo chính sách tự động, khi SMTP chưa được cấu hình, đăng ký không bắt buộc xác minh email trước khi đăng nhập. Địa chỉ email vẫn được lưu là chưa xác minh. Khi SMTP được cấu hình, hệ thống yêu cầu xác minh theo chính sách hiện hành. Không coi một email chưa xác minh là bằng chứng người dùng kiểm soát hộp thư đó.

Khôi phục mật khẩu và gửi lại thư xác minh chỉ hoạt động khi có cấu hình gửi email. Khi chưa có SMTP, hệ thống trả email_unavailable; không có thư xác minh hay thư khôi phục được gửi thành công.

Phiên đăng nhập và yêu cầu ghi

Website dùng cookie phiên bảo mật qua HTTPS. Các thao tác với phiên cần bảo vệ CSRF; yêu cầu ghi API cần Idempotency-Key để nhận diện thao tác lặp. Dữ liệu tổ chức chỉ được truy cập theo quyền của thành viên trong tổ chức đó. Không chia sẻ cookie phiên, mật khẩu, API key hay mã dự phòng trong phiếu hỗ trợ hoặc nhật ký công khai.

Theo dõi lỗi và trạng thái

API trả lỗi JSON có code, message và có thể có fields cho lỗi nhập liệu. Giữ X-Request-ID để cung cấp khi liên hệ hỗ trợ, cùng thời điểm và thao tác đã thực hiện; hãy loại bỏ bí mật khỏi nội dung gửi.

Xem trạng thái hệ thống để biết các phép đo được công bố. Chỉ số chưa có dữ liệu được trình bày là chưa xác định; việc API trả lời một yêu cầu không chứng minh lịch sử uptime hoặc khả năng cung cấp dịch vụ ngoài hệ thống.