Neukol API--EN


Add institutions

<h5>Interface introduction</h5> <ul> <li>An institutional account with a specific Sid and secret can register a new institutional account that can use the neuclass open interface.</li> </ul> <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/school/account">https://neukol.axzt.net/edu_openapi/school/account</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;">Parameter name</th> <th style="text-align: left;">Required</th> <th style="text-align: left;">Type</th> <th>Explanation</th> </tr> </thead> <tbody> </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: center;">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: center;">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: center;">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: center;">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;">name</td> <td style="text-align: left;">String</td> <td style="text-align: left;">True</td> <td style="text-align: center;">Institution name</td> <td style="text-align: left;">Neukol class</td> </tr> <tr> <td style="text-align: left;">adminPhone</td> <td style="text-align: left;">String</td> <td style="text-align: left;">True</td> <td style="text-align: center;">Institution contact phone number</td> <td style="text-align: left;">1387909853</td> </tr> <tr> <td style="text-align: left;">address</td> <td style="text-align: left;">String</td> <td style="text-align: left;">False</td> <td style="text-align: center;">Institution address</td> <td style="text-align: left;">1387909853</td> </tr> </tbody> </table> <h5>Response parameter</h5> <table> <thead> <tr> <th style="text-align: left;">parameter name</th> <th style="text-align: left;">Required</th> <th style="text-align: left;">Type</th> <th>Explanation</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">sid</td> <td style="text-align: left;">True</td> <td style="text-align: left;">string</td> <td>Institution acount</td> </tr> <tr> <td style="text-align: left;">secret</td> <td style="text-align: left;">True</td> <td style="text-align: left;">string</td> <td>Invoke open API signature key</td> </tr> </tbody> </table> <h5>Request example</h5> <pre><code>POST /edu_openapi/school/account HTTP/1.1 Host:neukol.axzt.net Content-Type: application/x-www-form-urlencoded Cookie: JSESSIONID=234A58638C0903778E6883C43807FAAA Content-Length: 141 timestamp=1614239658887&amp;sid=5f4df4846acce059dc7cc8ba&amp;sign=30c44fb4c7e51be2bedab910a37d71a8&amp;name=Testing educational institutions&amp;adminPhone=+861378907654&amp;address=Nanjing XX</code></pre> <h5>Response example</h5> <pre><code>{ "responseHeader": { "status": 200, "msg": "OK" }, "response": { "sid": "603773cee5e9be6d029461cb", "secret": "EgJvOvFjxi91Qwx4" } }</code></pre> <h5>Error code</h5> <table> <thead> <tr> <th style="text-align: left;">Code value</th> <th style="text-align: left;">Explanantion</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">321</td> <td style="text-align: left;">Mandatory parameters are missing</td> </tr> <tr> <td style="text-align: left;">707</td> <td style="text-align: left;">The institution contact phone number adminphone already exists and cannot be registered</td> </tr> <tr> <td style="text-align: left;">2110</td> <td style="text-align: left;">Current account does not have permission to call this interface. You can try to switch the SID with permission</td> </tr> </tbody> </table>

页面列表

ITEM_HTML