Description of Data Subscription Service

How to Activate the Service

1. Provide an endpoint URL to receive the data.

2. Debug the endpoint. Before configuring the service to your endpoind, we will push test data to your endpoint URL in the following format.

    {
        "SID": 123456,
        "Cmd": "Test",
        "Msg": "Register test.",
        "SafeKey": "String", //School's authentication strings encrypted in the format of md5(SECRET + TimeStamp)
        "TimeStamp": 123456789    //Timestamp
    }
   

After receiving the data, your endpoint URL should return the following data to response.

{
  "error_info": {       
    "errno": 1,// int type. 1 indicates the receiver receives successfully. Other errno indicate failure.
    "error": "程序正常执行"     // "Successful program execution". This field is only for reference, and cannot be used to judge whether the reception is successful
  }
}

Only when the above data is returned to us, can we consider the endpoint URL you provided is available for data reception.

Data Pushing Rules

1. POST in real time
2. Once the data push or data reception failed, we would push the data failed repeatedly untill its reception succeeds.
3. After receiving the data successfully, the receiver needs to return the following JSON-format response. After receiving the response, we will not try to resend. Then the next data will be pushed.

{
  "error_info": {       
    "errno": 1,     //int type. 1 indicates the receiver receives normally. Other codes indicate errors.
    "error": "程序正常执行"     //"Normal program execution". This field is only for reference, and cannot be used to judge whether the reception is successful
  }
}

Data You Can Subscribe To

In order to better grasp teachers' and students' teaching and learning behaviours, we record and classify the data of events happening in the virtual classroom.

For a more detailed description, please refer to the API documentation.

• Data pushed in real time during the class
• Data pushed after the class
• School-level data

Q&A

1. Received 10003 when testing the endpoint

   After receiving the data push from ClassIn, your endpoint needs to reply with the correct response. Error 10003 indicates that the format of the response data is incorrect, possibly not JSON, or the fields in JSON are incorrect.