Quản trị nhà trường
Kết nối hệ thống của nhà trường với API của Smrt English
Đọc hồ sơ học viên và lớp học của nhà trường từ hệ thống riêng của đơn vị bằng khóa API do Smrt English cấp.
API của Smrt English cho phép các hệ thống của nhà trường, chẳng hạn hệ thống quản lý thông tin học viên hoặc trang báo cáo, đọc hồ sơ học viên và lớp học. API chỉ cho phép đọc: API không thể thêm, sửa hoặc xóa bất kỳ dữ liệu nào trong Smrt English.
Nhận khóa API
Liên hệ Smrt English để yêu cầu khóa API (API key) cho nhà trường. Smrt English cấp và quản lý các khóa. Một khóa chỉ trả về học viên và lớp học của chính trường bạn.
Khi nhà trường đã có khóa, mở Dashboard, nhấn Home, rồi Settings (Cài đặt). Ô Client API cho biết số khóa đang hoạt động và số yêu cầu các khóa đó đã gửi trong 30 ngày qua.
Giao khóa cho người xây dựng phần tích hợp. Họ gửi khóa trong header X-API-Key của mọi yêu cầu.
Dữ liệu bạn có thể đọc
- Học viên: danh sách học viên với bộ lọc và tìm kiếm, hoặc một học viên theo mã người dùng (user ID) hay địa chỉ email, bao gồm các lớp học, bài tập đã hoàn thành, bài kiểm tra và thời gian học.
- Lớp học: danh sách lớp học, hoặc một lớp kèm giáo viên và danh sách học viên.
- Xác thực (Auth): kiểm tra xem khóa có hoạt động không.
Tài liệu tham khảo đầy đủ, với ví dụ bằng PHP, Python và JavaScript, có trong tài liệu API. Lập trình viên của bạn có thể thử mọi endpoint ngay trên trình duyệt từ trang thử nghiệm được liên kết ở đó.
Hãy bảo mật khóa như mật khẩu. Chỉ lưu khóa trên máy chủ, không bao giờ đặt trong trang web hoặc ứng dụng. Nếu bạn nghĩ khóa đã bị lộ, hãy liên hệ Smrt English ngay.
