API addSchoolStudent được sử dụng để liên kết một tài khoản đã đăng ký với tổ chức của bạn với tư cách là học sinh.
Ghi chú:
Lệnh gọi API yêu cầu các tham số SID, safeKey, timeStamp, tài khoản học sinh và tên học sinh.
Trong quá trình tích hợp API, addSchoolStudent là một trong những lệnh bạn sẽ thường xuyên gọi. Để gọi API thành công, vui lòng lưu ý:
- addSchoolStudent tương đương với chức năng quản lý học sinh tại Trang quản lý ClassIn (Truy cập Trang quản lý ClassIn – mục Giảng dạy – Học viên – Thêm học sinh). Người dùng đã tạo tài khoản ClassIn phải được thêm vào trường của bạn trước, sau đó mới có thể được xếp vào các khóa học/lớp học. Nếu người dùng không phải là học sinh thuộc trường của bạn, mã lỗi sẽ được trả về khi bạn gọi API thêm người dùng này vào các khóa học/lớp học.
- Người dùng mới chưa đăng ký tài khoản ClassIn có thể được thêm trực tiếp vào tổ chức của bạn khi bạn gọi API Tạo tài khoản (Register User). Đối với người dùng đã tạo tài khoản, việc triển khai API Tạo tài khoản sẽ trả về mã lỗi 135.
The addSchoolStudent interface is to bind a registered account to your institution in the student identity.
Notes:
The API call requires SID, safeKey, timeStamp, student account and student name.
In API integration, addSchoolStudent is an interface that you must call. To make an API call successfully, please note that:
- The addSchoolStudent interface is equivalent to the student management function in the ClassIn management console. Path: ClassIn management console-Home-Teaching-Students-Add Student. A registered user must be added to your institution first, then can be arranged with lessons. If the user is not a student belonging to your institution, an error code will be returned when you call API to arrange lessons for the user.
- New users that have not registered in the ClassIn system before can be directly added to your institution when you call the register interface. Please refer to the register interface for detailed information. For registered users, the register API implementation returns error code 135. Please then call the addSchoolStudent interface to bind the account to your institution.
URL #
https://api.eeo.cn/partner/api/course.api.php?action=addSchoolStudent
HTTP Request Methods #
- POST
Coding Format #
- UTF-8
Request Data #
| Key | Bắt buộc | Yêu cầu thêm | Mô tả | Hướng dẫn |
|---|---|---|---|---|
| SID | Bắt buộc | — | ID của trường | Xem dữ liệu này tại Trang quản lý classin.com trong mục API |
| safeKey | Bắt buộc | Fixed 32-bit all lowercase characters | Khóa bảo mật xác thực trường học | safeKey=MD5(SECRET+timeStamp) |
| timeStamp | Bắt buộc | — | Theo Unix Epoch timestamp & có hiệu lực trong vòng 20 phút | Thời gian UNIX Epoch là số giây đã trôi qua kể từ 00:00:00 (giờ chuẩn quốc tế) vào ngày 1 tháng 1 năm 1970 |
| studentAccount | Bắt buộc | Số điện thoại hoặc email. Định dạng: 00 Mã vùng-Số điện thoại. Có thể sử dụng studentUid hoặc studentAccount. Nếu studentAccount và studentUid được truyền cùng lúc, tham số studentUid sẽ được ưu tiên | Tài khoản của học sinh | Ví dụ：Số điện thoại Việt Nam, 0901234567, vui lòng gửi tham số 0084-901234567 |
| studentName | Bắt buộc | 1-24 ký tự, nếu vượt quá 24 ký tự thì hệ thống sẽ tự động cắt ngắn | Tên học sinh sẽ được hiển thị trong trang quản lý học sinh tại classin.com | — |
Response Data #
| Key | Định dạng | Phản hồi | Ý nghĩa |
|---|---|---|---|
| error_info | object | Return information object | |
| └ errno | number | 1 | Mã lỗi |
| └ error | string | “Routine execution” | Thông tin lỗi |
Sample #
- HTTP Request
POST /partner/api/course.api.php?action=addSchoolStudent HTTP/1.1
Host: root_url
Content-Type: application/x-www-form-urlencoded
Cache-Control: no-cache
SID=2339736&safeKey=dcbc0d041c043f3a4decabe6d24e61dd&timeStamp=1493712683&studentAccount=001-8006437676&studentName=Jeck
- Shell cURL analog request instruction
curl -H "Content-Type: application/x-www-form-urlencoded" -X "POST" \
-d "SID=1234567" \
-d "safeKey=0f7781b3033527a8cc2b1abbf45a5fd2" \
-d "timeStamp=1484719085" \
-d "studentAccount=001-8006437676" \
-d "studentName=Jeck" \
"https://api.eeo.cn/partner/api/course.api.php?action=addSchoolStudent"
Response sample（The normal return json packet example） #
{
"error_info": {
"errno": 1,
"error": "程序正常执行"
}
}
Error Code Description #
| Error Code | Description |
|---|---|
| 1 | Thành công |
| 100 | Parameters sai định dạng hoặc không hoàn chỉnh |
| 102 | Không có quyền thao tác (Xác thực bảo mật thất bại) |
| 104 | Thao tác thất bại |
| 113 | Số điện thoại chưa được đăng ký |
| 114 | Lỗi server |
| 128 | Tài khoản master không thể được thêm vào danh sách học sinh |
| 133 | Tài khoản này đã được thêm vào danh sách học sinh của trường |
| 134 | Số điện thoại không hợp lệ |
| 288 | Mã vùng không hợp lệ |
| 886 | Tài khoản đã bị người dùng xóa |
