Neukol API--EN


Get link of neukol management background

<h5>Interface introduction</h5> <p>-This interface can obtain a link to the neukol institution management background. After opening the link, the user can enter the neukol management background of the current institution without secret and carry out other operations such as course supervision management.</p> <h5>Interface information</h5> <table> <thead> <tr> <th style="text-align: left;"></th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">URL</td> <td style="text-align: left;"><a href="https://neukol.axzt.net/edu_openapi/user_school/neukol_url">https://neukol.axzt.net/edu_openapi/user_school/neukol_url</a></td> </tr> <tr> <td style="text-align: left;">HTTP Request Methods</td> <td style="text-align: left;">POST</td> </tr> <tr> <td style="text-align: left;">Coding format</td> <td style="text-align: left;">UTF-8</td> </tr> </tbody> </table> <h5>Request header</h5> <table> <thead> <tr> <th style="text-align: left;">Field name</th> <th style="text-align: left;">Type</th> <th style="text-align: left;">Required</th> <th style="text-align: left;">Description</th> <th style="text-align: left;">Example</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">no</td> <td style="text-align: left;">no</td> <td style="text-align: left;">no</td> <td style="text-align: left;">no</td> <td style="text-align: left;">no</td> </tr> </tbody> </table> <h5>Form parameter</h5> <table> <thead> <tr> <th style="text-align: left;">Field name</th> <th style="text-align: left;">Type</th> <th style="text-align: left;">Required</th> <th style="text-align: left;">Description</th> <th style="text-align: left;">Example</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">sid</td> <td style="text-align: left;">String</td> <td style="text-align: left;">True</td> <td style="text-align: left;">Institution ID</td> <td style="text-align: left;">5f1140092302bd0ac2dbc7c4</td> </tr> <tr> <td style="text-align: left;">sign</td> <td style="text-align: left;">String</td> <td style="text-align: left;">True</td> <td style="text-align: left;">Fixed 32-bit all lowercase characters, institution authentication security key,sign=MD5(params+SECRET),Among them, params represents the concatenated string of all parameters in the request body except sign in lexicographic order(like: “key1=value1key2=value2”)</td> <td style="text-align: left;">c09636a3a529a386fdaa389228e36fac</td> </tr> <tr> <td style="text-align: left;">timestamp</td> <td style="text-align: left;">Long</td> <td style="text-align: left;">True</td> <td style="text-align: left;">Unix Epoch timestamp within 20 minutes of current calling interface, unit: milliseconds</td> <td style="text-align: left;">1600140360000</td> </tr> <tr> <td style="text-align: left;">phone</td> <td style="text-align: left;">String</td> <td style="text-align: left;">Trur</td> <td style="text-align: left;">User's mobile phone number. If the current user is not an organization administrator, this interface will automatically register him as the administrator of the current organization. After becoming an administrator, the user can use the link returned by this interface to access the management background without secret, or the user can manually log in to the management background through the mobile phone number verification code.</td> <td style="text-align: left;">18321016873</td> </tr> <tr> <td style="text-align: left;">code</td> <td style="text-align: left;">String</td> <td style="text-align: left;">False</td> <td style="text-align: left;">The country code corresponding to the user's mobile phone number. If it is not transmitted, it defaults to 86</td> <td style="text-align: left;">86</td> </tr> <tr> <td style="text-align: left;">teachers</td> <td style="text-align: left;">List</td> <td style="text-align: left;">False</td> <td style="text-align: left;">The set of teacher IDS is not limited if it is not transferred. The maximum transfer value is 30. After the value is transferred, the class supervisor can only see the class of the corresponding teacher in the class supervision management<br>Format 1: 3-20 digits plus character combination ID does not allow special characters to exist, which means ordinary account(like: tea00001)<br>Format 2 : country code + character’ # ‘ + mobile phone number, indicating mobile phone account number(like: 86#15751860597)</td> <td style="text-align: left;">tea0011,tea0012</td> </tr> </tbody> </table> <h5>Response parameter explanation</h5> <table> <thead> <tr> <th style="text-align: left;">Parameter name</th> <th style="text-align: left;">Type</th> <th>Description</th> <th>Example</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">responseHeader</td> <td style="text-align: left;">Object</td> <td>Response header information</td> </tr> <tr> <td style="text-align: left;"> └status</td> <td style="text-align: left;">int</td> <td>HTTP corresponding status code</td> <td>200</td> </tr> <tr> <td style="text-align: left;"> └msg</td> <td style="text-align: left;">String</td> <td>Error message</td> <td>OK</td> </tr> <tr> <td style="text-align: left;">response</td> <td style="text-align: left;">String</td> <td>Link to neukol organization management background</td> <td>&quot;Link format to be determined&quot;</td> </tr> </tbody> </table> <h5>Request example</h5> <pre><code>Follow up supplement</code></pre> <h5>Response example</h5> <pre><code>{ "responseHeader": { "status": 200, "msg": "OK" }, "response": "Link format to be determined" }</code></pre> <h5>Error code</h5> <table> <thead> <tr> <th style="text-align: left;">Error code</th> <th>Explanation</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">321</td> <td>Parameter format error</td> </tr> <tr> <td style="text-align: left;">2000</td> <td>sign certification failed</td> </tr> <tr> <td style="text-align: left;">2001</td> <td>Request timeout</td> </tr> <tr> <td style="text-align: left;">2002</td> <td>Institution does not open an open interface</td> </tr> <tr> <td style="text-align: left;">2010</td> <td>Institution is inexistent</td> </tr> <tr> <td style="text-align: left;">500</td> <td>unknown exception on the server</td> </tr> </tbody> </table>

页面列表

ITEM_HTML