玩瞳文档中心


上传点读数据

<p><strong>服务:</strong>api-cloud <strong>API:</strong>将点读框与文本写入私有资源库API <strong>API:</strong> <code>http://cloud-api1.51wanxue.com/api-cloud/page/saveUserFingerData</code> <strong>请求方式:</strong>POST <strong>api开发者:</strong> 林垚 <strong>是否授权登录:</strong> 是 <strong>简要描述:</strong> 客户希望将自己点读框能完整的写入到其私库</p> <p><strong>参数:</strong></p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">token</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>token,该参数需要放在请求头部</td> </tr> <tr> <td style="text-align: left;">fingerJson</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>用户的点读数据</td> </tr> </tbody> </table> <p><strong>fingerJson示例</strong>:</p> <pre><code class="language-json">{ &amp;quot;type&amp;quot;: 1, &amp;quot;points&amp;quot;: 4, &amp;quot;position&amp;quot;: [ { &amp;quot;x&amp;quot;: 26, &amp;quot;y&amp;quot;: 250 }, { &amp;quot;x&amp;quot;: 1714, &amp;quot;y&amp;quot;: 250 }, { &amp;quot;x&amp;quot;: 1714, &amp;quot;y&amp;quot;: 410 }, { &amp;quot;x&amp;quot;: 26, &amp;quot;y&amp;quot;: 410 } ], &amp;quot;physical&amp;quot;: 4, &amp;quot;pageType&amp;quot;: 1, &amp;quot;extraData&amp;quot;: &amp;quot;PSENGLISHG511505_-1_2&amp;quot;, &amp;quot;repoId&amp;quot;: 483, &amp;quot;pageId&amp;quot;: 516633, &amp;quot;userFingerId&amp;quot;: &amp;quot;fingeId_1&amp;quot;, &amp;quot;userText&amp;quot;: &amp;quot;test&amp;quot; }</code></pre> <p><strong>参数说明</strong></p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">type</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>点读框的类型 0为矩形 1为多边形</td> </tr> <tr> <td style="text-align: left;">points</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>多边形的点数</td> </tr> <tr> <td style="text-align: left;">position</td> <td style="text-align: left;">是</td> <td style="text-align: left;">Json</td> <td>如果是矩形 只需要左上角和右下角左标,多边形则需要所有顺时针点左标</td> </tr> <tr> <td style="text-align: left;">physical</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>物理页码</td> </tr> <tr> <td style="text-align: left;">pageType</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>书页跨页类型</td> <td>0位跨页 1为左单页 2为右单页</td> </tr> <tr> <td style="text-align: left;">extraData</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>用户的extraData</td> </tr> <tr> <td style="text-align: left;">repoId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">Long</td> <td>资源库Id</td> </tr> <tr> <td style="text-align: left;">pageId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">Long</td> <td>书页的pageId</td> </tr> <tr> <td style="text-align: left;">userFingerId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>用户本地的点读框Id (所有都是唯一不重复)</td> </tr> <tr> <td style="text-align: left;">userText</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>用户的文本数据,长度不大于3000</td> </tr> </tbody> </table> <p><strong>返回示例</strong></p> <pre><code class="language-json">{ &amp;quot;code&amp;quot;: 0, &amp;quot;msg&amp;quot;: &amp;quot;ok&amp;quot;, &amp;quot;data&amp;quot;: &amp;quot;保存成功&amp;quot; }</code></pre> <p><strong>返回数据参数说明 </strong></p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">code</td> <td style="text-align: left;">int</td> <td>请求返回码 0(表示成功)</td> </tr> <tr> <td style="text-align: left;">msg</td> <td style="text-align: left;">String</td> <td>系统返回提示</td> </tr> <tr> <td style="text-align: left;">data</td> <td style="text-align: left;">Object</td> <td>返回数据</td> </tr> </tbody> </table>

页面列表

ITEM_HTML