Neukol API--EN


Preview file (folder)

<h5>Interface introduction</h5> <p>Get the preview picture link and information for the specified file. When a folder ID is passed in, only the folder name field is available.</p> <h5>Request 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/netdisk/view">https://neukol.axzt.net/edu_openapi/netdisk/view</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;">Required</th> <th style="text-align: left;">Type</th> <th>Explanation</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>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>Description</th> <th>Example</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">timestamp</td> <td style="text-align: left;">long</td> <td style="text-align: left;">True</td> <td>Timestamp, the timestamp within 20 minutes of the sending request time</td> <td>1605766708325</td> </tr> <tr> <td style="text-align: left;">sid</td> <td style="text-align: left;">string</td> <td style="text-align: left;">True</td> <td>The unique identifier of the institution is available on the first page of API description</td> <td>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>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> </tr> <tr> <td style="text-align: left;">id</td> <td style="text-align: left;">string</td> <td style="text-align: left;">True</td> <td>File (folder) ID (the ID returned when uploading files) only the folder name field is returned when the folder ID is passed in</td> <td>5fb4b9911debac4ab01ff125</td> </tr> </tbody> </table> <h5>Response 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>Description</th> <th>Example</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">responseHeader</td> <td style="text-align: left;">Object</td> <td style="text-align: left;"></td> <td>Response header information</td> </tr> <tr> <td style="text-align: left;"> └status</td> <td style="text-align: left;">number</td> <td style="text-align: left;">True</td> <td>HTTP response status code</td> <td>200</td> </tr> <tr> <td style="text-align: left;"> └msg</td> <td style="text-align: left;">String</td> <td style="text-align: left;">True</td> <td>Return information</td> <td>OK</td> </tr> <tr> <td style="text-align: left;">response</td> <td style="text-align: left;">Object</td> <td style="text-align: left;"></td> <td>Response body content</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>File name</td> <td>Test documentation.docx</td> </tr> <tr> <td style="text-align: left;"> └size</td> <td style="text-align: left;">Long</td> <td style="text-align: left;"></td> <td>File size, unit: bytes</td> <td>132941</td> </tr> <tr> <td style="text-align: left;"> └previewWidth</td> <td style="text-align: left;">int</td> <td style="text-align: left;"></td> <td>Preview picture width</td> <td>793</td> </tr> <tr> <td style="text-align: left;"> └previewHeight</td> <td style="text-align: left;">int</td> <td style="text-align: left;">True</td> <td>Preview picture height</td> <td>1122</td> </tr> <tr> <td style="text-align: left;"> └imgUrls</td> <td style="text-align: left;">String[]</td> <td style="text-align: left;"></td> <td>Preview picture link array</td> <td>&quot;<a href="https://static.axzt.net/aliyunConvert/f70c249e1729397f03b8e64e3875f69e12d6971d/1.jpg?Expires=1617967886&OSSAccessKeyId=LTAI4G6r2rurQv6PkswEGHGc&Signature=vFFETy0Y6Xi8NBkdVF6DYwQyp5E%3D","https://static.axzt.net/aliyunConvert/f70c249e1729397f03b8e64e3875f69e12d6971d/2.jpg?Expires=1617967886&OSSAccessKeyId=LTAI4G6r2rurQv6PkswEGHGc&Signature=2XT0t1hJU6H9MDWO1QcLGvyQMqY%3D","https://static.axzt.net/aliyunConvert/f70c249e1729397f03b8e64e3875f69e12d6971d/3.jpg?Expires=1617967886&OSSAccessKeyId=LTAI4G6r2rurQv6PkswEGHGc&Signature=xCM%2Bo8s7v%2B0FVI%2FaYgcovGfrVLg%3D">https://static.axzt.net/aliyunConvert/f70c249e1729397f03b8e64e3875f69e12d6971d/1.jpg?Expires=1617967886&OSSAccessKeyId=LTAI4G6r2rurQv6PkswEGHGc&Signature=vFFETy0Y6Xi8NBkdVF6DYwQyp5E%3D","https://static.axzt.net/aliyunConvert/f70c249e1729397f03b8e64e3875f69e12d6971d/2.jpg?Expires=1617967886&OSSAccessKeyId=LTAI4G6r2rurQv6PkswEGHGc&Signature=2XT0t1hJU6H9MDWO1QcLGvyQMqY%3D","https://static.axzt.net/aliyunConvert/f70c249e1729397f03b8e64e3875f69e12d6971d/3.jpg?Expires=1617967886&OSSAccessKeyId=LTAI4G6r2rurQv6PkswEGHGc&Signature=xCM%2Bo8s7v%2B0FVI%2FaYgcovGfrVLg%3D</a>&quot;</td> </tr> <tr> <td style="text-align: left;"> └urlExpireTime</td> <td style="text-align: left;">int</td> <td style="text-align: left;">True</td> <td>Link expiration time</td> <td>1617967886280</td> </tr> </tbody> </table> <h5>Request example</h5> <pre><code>POST /edu_openapi/netdisk/view HTTP/1.1 Host: https://neukol.axzt.net/ Content-Type: application/x-www-form-urlencoded timestamp=1605775283591&amp;sid=5f1140092302bd0ac2dbc7c4&amp;sign=aa16401e20207f1f2ccee04976002eb6&amp;id=606fca32e5e9be732e4de41e </code></pre> <h5>Response example</h5> <pre><code>{ "responseHeader": { "status": 200, "msg": "OK" }, "response": { "name": "Test documentation.docx", "size": 132941, "previewWidth": 793, "previewHeigth": 1122, "imgUrls": [ "https://static.axzt.net/aliyunConvert/f70c249e1729397f03b8e64e3875f69e12d6971d/1.jpg?Expires=1617967886&amp;OSSAccessKeyId=LTAI4G6r2rurQv6PkswEGHGc&amp;Signature=vFFETy0Y6Xi8NBkdVF6DYwQyp5E%3D", "https://static.axzt.net/aliyunConvert/f70c249e1729397f03b8e64e3875f69e12d6971d/2.jpg?Expires=1617967886&amp;OSSAccessKeyId=LTAI4G6r2rurQv6PkswEGHGc&amp;Signature=2XT0t1hJU6H9MDWO1QcLGvyQMqY%3D", "https://static.axzt.net/aliyunConvert/f70c249e1729397f03b8e64e3875f69e12d6971d/3.jpg?Expires=1617967886&amp;OSSAccessKeyId=LTAI4G6r2rurQv6PkswEGHGc&amp;Signature=xCM%2Bo8s7v%2B0FVI%2FaYgcovGfrVLg%3D" ], "urlExpireTime": 1617967886280 } } </code></pre> <h5>Error code</h5> <table> <thead> <tr> <th style="text-align: left;">Code value</th> <th style="text-align: left;">Explanation</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">200</td> <td style="text-align: left;">query was successful</td> </tr> <tr> <td style="text-align: left;">701</td> <td style="text-align: left;">file does not exist</td> </tr> <tr> <td style="text-align: left;">702</td> <td style="text-align: left;">The file is being converted</td> </tr> <tr> <td style="text-align: left;">721</td> <td style="text-align: left;">File conversion failed</td> </tr> <tr> <td style="text-align: left;">9994</td> <td style="text-align: left;">Parameter format error</td> </tr> <tr> <td style="text-align: left;">2000</td> <td style="text-align: left;">sign certification failed</td> </tr> <tr> <td style="text-align: left;">2001</td> <td style="text-align: left;">Request timeout</td> </tr> <tr> <td style="text-align: left;">2002</td> <td style="text-align: left;">Institution does not open an open interface</td> </tr> <tr> <td style="text-align: left;">2010</td> <td style="text-align: left;">Institution is inexistent</td> </tr> <tr> <td style="text-align: left;">500</td> <td style="text-align: left;">unknown exception on the server</td> </tr> </tbody> </table>

页面列表

ITEM_HTML