Giao diện đăng ký được sử dụng để tổ chức đăng ký tài khoản ClassIn thay mặt cho người dùng. Trong tích hợp API, đây là một giao diện không thể bỏ qua. Vui lòng đảm bảo rằng chủ sở hữu số điện thoại di động (hoặc địa chỉ email) đã được thông báo và đồng ý với thao tác này.
Lệnh gọi API yêu cầu các thông tin sau: SID, safeKey, timeStamp, số điện thoại di động hợp lệ (hoặc địa chỉ email) và mật khẩu. Số điện thoại di động hợp lệ là tài khoản được sử dụng để đăng nhập vào ứng dụng ClassIn. Mật khẩu có thể là dạng văn bản hoặc đã được mã hóa MD5 (khuyến nghị sử dụng mã hóa MD5). Biệt danh và hình đại diện là tùy chọn. User ID (UID) sẽ được trả về sau khi đăng ký thành công. UID là mã định danh duy nhất của tài khoản và được sử dụng trong các lần gọi API sau đó. Vì vậy, hãy lưu trữ UID trong cơ sở dữ liệu của bạn.
Ghi chú:
- Hình đại diện được sử dụng để hiển thị trong ứng dụng ClassIn.
- Biệt danh được sử dụng để hiển thị trong ứng dụng ClassIn. Truyền tham số 1 hoặc 2 trong addToSchoolMember sẽ đồng bộ hóa biệt danh này lên trang quản lý học sinh/giáo viên trong Trang quản lý ClassIn.
Người dùng mới đăng ký sẽ không hiển thị trên trang quản lý học sinh/giáo viên trong Trang quản lý của trường theo mặc định. Có hai cách để liên kết người dùng với trường của bạn:
- Truyền các tham số sau đến addToSchoolMember. 1: thêm học sinh vào trường; 2: thêm giáo viên vào trường; các giá trị khác không thể thêm vào trường.
- Gọi add Student và add Teacher để liên kết người dùng với trường của bạn trực tiếp dưới vai trò học sinh hoặc giáo viên.
- Tham số addToSchoolMember sẽ luôn có hiệu lực, bất kể là lần đăng ký đầu tiên hay không.
Nếu bạn bỏ qua quy trình thêm người dùng vào trường, hệ thống sẽ trả về lỗi khi bạn xếp lịch học cho người dùng thông qua API. (Ví dụ lỗi: Người dùng không phải là giáo viên trong trường của bạn, v.v.)
Vui lòng lưu ý:
- Nếu số điện thoại di động hoặc email đã được đăng ký tài khoản ClassIn, khi bạn gọi register-user, mã lỗi 135 sẽ được trả về cùng với UID.
- Biệt danh, hình đại diện và mật khẩu sẽ chỉ có hiệu lực trong lần đăng ký đầu tiên.
The register interface is for the institution to register a ClassIn account on behalf of users. In API integration, it is an interface that cannot be skipped. Please make sure that the owner of the mobile phone number(or email address) has been informed and agreed on the operation.
The API call requires SID, safeKey, timeStamp, a valid mobile phone number(or email address) and a password. The valid mobile phone number is the account used to log in to ClassIn App. The password can either be plaintext or MD5 encrypted (MD5 encryption is recommended.). The nickname and avatar are optional. The User ID(UID) will be returned after a successful registration. The UID is the unique ID of the account and is used in subsequent API calls. Therefore, please store UIDs in your database.
Notes:
- The avatar is used to display in the ClassIn App.
- The nickname is used to display in the ClassIn client. Pass 1 or 2 in addToSchoolMember to synchronize the nickname to the student\teacher management page in the ClassIn management console.
- Newly registered users are not displayed on the student/teacher management page in the management console by default. Here are two ways to bind users to your institution.
- Pass the parameter addToSchoolMember when calling this interface. 1: add as an institution student; 2: add as an institution teacher; other values do not add as institution members)
- Call add Student interface and add Teacher interface to bind the user to your institution as students or teachers.
- The
addToSchoolMemberparameter will always take effect, regardless of whether it is the first time registering or not.
- If the above process of adding users to institutions is skipped, it will return errors when you schedule lessons for the users via API. (Error example: The user is not a teacher in your institution, etc.)
Please note that:
- If the mobile phone number or email is already registered as ClassIn account, when you call register-user interface, error code 135 will be returned, together with the UID.
- The nickname, avatar, and password will only take effect during the first registration.
URL #
https://api.eeo.cn/partner/api/course.api.php?action=register
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 |
| telephone | Bắt buộc (Hoặc có thể bỏ qua và sử dụng email) | Định dạng: 00 Mã vùng-Số điện thoại. Lưu ý: Đối với số điện thoại di động ở Trung Quốc Đại Lục, không nhập mã quốc gia, và số đầu tiên của số điện thoại không được là 0. | Số điện thoại dùng để đăng ký | Ví dụ：Số điện thoại Việt Nam, 0901234567, vui lòng gửi tham số 0084-901234567 |
| Bắt buộc (Hoặc có thể bỏ qua và sử dụng telephone) | — | — | ||
| nickname | Không bắt buộc | Độ dài tối đa 24 ký tự. Nếu biệt danh vượt quá 24 ký tự thì hệ thống sẽ tự động cắt ngắn | — | Nếu tham số này được gửi, nó sẽ được sử dụng làm biệt danh của giáo viên hoặc học sinh để hiển thị trên ứng dụng. Nếu biệt danh không được truyền, số điện thoại di động sẽ được sử dụng làm biệt danh của giáo viên hoặc học sinh. Khi người dùng đăng nhập vào ứng dụng, một cửa sổ sẽ xuất hiện để người dùng điền biệt danh. Biệt danh được hiển thị dưới camera của người dùng trong lớp học ảo, với tối đa 24 ký tự. |
| password | Bắt buộc (Hoặc có thể bỏ qua và dùng md5pass) | — | Mật khẩu dạng văn bản không mã hóa | Mật khẩu có độ dài trong khoảng từ 6 – 20 ký tự. Nếu mật khẩu không đúng như yêu cầu thì báo lỗi sẽ hiển thị. |
| md5pass | Bắt buộc (Hoặc có thể bỏ qua và dùng password) | — | Mật khẩu được mã hóa MD5 | Mã hóa 32-bit MD5 |
| Filedata | Không bắt buộc | Binary stream | Ảnh đại diện của người dùng sẽ hiển thị trên ứng dụng ClassIn. Nếu không upload phần này, khi người dùng truy cập, ứng dụng sẽ hiển thị màn hình thiết lập ảnh đại diện. | Định dạng：jpg，jpeg，gif，png Kích cỡ：300*300 Dung lượng: tối đa 1MB |
| addToSchoolMember | Không bắt buộc | 0: Không thêm người dùng này vào trường； 1: Thêm vào trường với vai trò học sinh； 2: Thêm vào trường với vai trò giáo viên； Các giá trị khác: Không thêm người dùng này vào trường; Và nếu để trống thì giá trị mặc định là 0. | Khi tham số addToSchoolMember là 1 hoặc 2, người dùng sẽ hiển thị tại Trang quản lý của trường với vai trò là học sinh hoặc giáo viên. Và biệt danh sẽ được sử dụng để hiển thị tại trang danh sách học sinh/giáo viên của trường | Quyết định xem có thêm tài khoản vào trường hay không. |
Response Data #
| Key | Định dạng | Phản hồi | Ý nghĩa |
|---|---|---|---|
| data | number | Trả về ID của người dùng (UID) | |
| error_info | object | Return message object | |
| └ errno | number | 1 | Mã lỗi |
| └ error | string | “Normal execution” | Thông tin lỗi |
Sample #
- HTTP Request
POST /partner/api/course.api.php?action=register HTTP/1.1
Host: root_url
Content-Type: application/x-www-form-urlencoded
Cache-Control: no-cache
SID=2339736&safeKey=3276433ab0216d9aec2621431cc12248&timeStamp=1494407873&telephone=001-8006437676&password=123456&Filedata=@~/photo.jpg
- 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 "telephone=001-8006437676" \
-d "password=123456" \
-d "Filedata=@D:\touxiang.jpg"\
"https://api.eeo.cn/partner/api/course.api.php?action=register"
Response Sample（The normal return json packet example） #
{
"data": 1001930,
"error_info": {
"errno": "1",
"error": "程序正常执行/Normal execution"
}
}
Error Code Instruction #
| Error Code | Mô tả |
|---|---|
| 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). |
| 114 | Lỗi server |
| 131 | Tạo tài khoản thất bại |
| 134 | Số điện thoại không hợp lệ |
| 135 | Số điện thoại đã được đăng ký (thông tin UID của người dùng sẽ được trả về cùng lúc) |
| 137 | Độ dài mật khẩu không hợp lệ (6-20 ký tự). |
| 224 | Định dạng hình ảnh không hợp lệ |
| 288 | Mã vùng không hợp lệ |
| 340 | Tạo tài khoản thành công, thiết lập ảnh đại diện thất bại. |
| 341 | Kích cỡ hình ảnh không hợp lệ (300 * 300). |
| 342 | Dung lượng hình ảnh quá lớn (tối đa 1MB). |
| 461 | Email đã được đăng ký (thông tin UID của người dùng sẽ được trả về cùng lúc). |
| 820 | Tạo tài khoản thành công, nhưng thêm người dùng làm học sinh của trường thất bại |
| 821 | Tạo tài khoản thành công, nhưng thêm người dùng làm giáo viên của trường thất bại |
| 845 | Số lượng giáo viên của trường đã đạt đến giới hạn |
