Tài liệu API

Smrt English Client API

API chỉ đọc, trả dữ liệu học viên và lớp học về hệ thống của đơn vị. Mỗi khóa API (API key) chỉ truy cập được dữ liệu của chính đơn vị sở hữu khóa đó.

Mở trang thử nghiệm API

Cách thức hoạt động

Cách một yêu cầu được xử lý.

Hệ thống của đơn vị gửi yêu cầu lấy dữ liệu một học viên hoặc một lớp kèm khóa API riêng, và API trả về dữ liệu ở chế độ chỉ đọc.

Hệ thống của đơn vịPhần mềm quản lý học viên hoặc công cụ báo cáo của đơn vị.

Khóa API của đơn vịĐược gửi kèm mọi yêu cầu và gắn với đơn vị.

Smrt English APICác endpoint chỉ đọc cho học viên và lớp học.

Dữ liệu của đơn vịĐiểm, điểm danh và danh sách lớp ở định dạng JSON.

keyboard_arrow_up

Smrt English API

vpn_key Authentication

All API requests require authentication using an API key passed in the HTTP header.

Header Format

X-API-Key: your_institution_api_key

Authentication Methods

The API supports the following header variations:

X-API-Key (recommended)
X-Api-Key
HTTP_X_API_KEY (server variable)

Security Notes

Keep your API key confidential and do not share it outside your institution
Never expose API keys in client-side code or public repositories
Use HTTPS for all API requests (enforced in production)
Your API key only provides access to your institution's student data