Register Users

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 Client. 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 client.
• 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.

  1. 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)
  2. Call add Student interface and add Teacher interface to bind the user to your institution as students or teachers.
  3. The addToSchoolMember parameter 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:

1. 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.
2. 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

Response Data

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