欢迎!这里是飞印API文档

飞印API文档描述、示例


创建和使用飞印应用

<h1>提要:</h1> <h3>飞印应用是将您的应用与所有的飞印打印机连接起来的一个有效途径,核心关键是获取到一个飞印应用ID,通过飞印应用ID,每个飞印用户都可以添加开发者的自有应用。</h3> <p>以下是如何创建一个飞印应用和如何使用的图例介绍:</p> <p>1、<a href="#1">登录飞印公众号</a> 2、<a href="#2">完善开发者信息</a> 3、<a href="#3">创建一个新的飞印应用</a> 4、<a href="#4">选择一个名字,设置登录地址、回调地址</a> 5、<a href="#5">保护你的应用安全</a> 6、<a href="#6">开始使用飞印APP</a> 7、<a href="#7">从飞印平台进入飞印应用</a></p> <h2 id="1">1、登录飞印公众号</h2> <p>要成为开发者,首先要关注飞印公众号,成为飞印用户: 您微信扫码关注飞印公众号,或者输入“飞印”关键字也可关注。</p> <p><img src="https://www.showdoc.cc/server/api/common/visitfile/sign/c05596b08022e1c5e8fc02f2162aa353?showdoc=.jpg" alt="飞印公众号" title="飞印公众号" /></p> <h2 id="2">2、完善开发者信息</h2> <h3>打开飞印公众号的“设备管理”</h3> <p><img src="https://www.showdoc.cc/server/api/common/visitfile/sign/05b8b281ace432243f3127bc96ad0df8?showdoc=.jpg" alt="打开“设备管理”" title="打开“设备管理”" /></p> <h3>点击“个人中心”</h3> <p><img src="https://www.showdoc.cc/server/api/common/visitfile/sign/e0401ee67fc056393bef3875edb9b5e2?showdoc=.jpg" alt="点击“个人中心”" title="点击“个人中心”" /></p> <h3>点击“开发管理”</h3> <p><img src="https://www.showdoc.cc/server/api/common/visitfile/sign/be389f681a21aae43ee5b8384b6ba078?showdoc=.jpg" alt="打开“开发管理”" title="打开“开发管理”" /></p> <h3>打开“开发者信息 - 我的资料”</h3> <h5>请完善开发者信息,如果您是公司开发者,请务必上传公司的营业执照。</h5> <p><img src="https://www.showdoc.cc/server/api/common/visitfile/sign/2d47f1f48a60c1c30d865978494748f9?showdoc=.jpg" alt="完善“我的资料”" title="完善“我的资料”" /></p> <h4>至此,您的信息已经完善,可以去创建应用了。</h4> <h2 id="3">3、创建一个新的飞印应用</h2> <h3>打开“主菜单-创建应用”</h3> <p><img src="https://www.showdoc.cc/server/api/common/visitfile/sign/ad207e0accab05930917a79081b3a37f?showdoc=.jpg" alt="创建应用" title="创建应用" /></p> <h3>点击“创建应用”</h3> <p><img src="https://www.showdoc.cc/server/api/common/visitfile/sign/54dad8b21e1c54219d28564bf71a1362?showdoc=.jpg" alt="创建应用" title="创建应用" /></p> <h2 id="4">4、选择一个名字,设置登录地址、回调地址</h2> <h3>填写“应用信息”</h3> <p><img src="https://www.showdoc.cc/server/api/common/visitfile/sign/666846aa1ede272ec58803efb22c372c?showdoc=.jpg" alt="填写应用信息" title="填写应用信息" /></p> <h4>登录地址和回调地址请仔细填写,设置为您服务器的URL。</h4> <blockquote> <p>请注意:用户进入应用后,我们将引导用户打开您设定的登录地址,这个地址可以为产品介绍应用页或者系统登录页等信息。 回调地址请确保7X24小时的不间断运行,我们将会通过这个接口接受响应的程度判断您应用的健康程度。</p> </blockquote> <h2 id="5">5、保护你的应用安全</h2> <h4>为了确保您的应用安全,调试结束,正式上线时,请输入您服务器的IP地址白名单,一旦设置,我们将拒绝其他IP地址发起的访问请求,确保您的通信信道的安全。</h4> <p><img src="https://www.showdoc.cc/server/api/common/visitfile/sign/c144d3a62979da7f538c816b7770bb01?showdoc=.jpg" alt="设置API接口" title="设置API接口" /> <img src="https://www.showdoc.cc/server/api/common/visitfile/sign/afe904957dfef2ac41d122640a84561b?showdoc=.jpg" alt="设置回调地址" title="设置回调地址" /></p> <blockquote> <p>请注意:IP白名单是在当前账户下全局生效,一旦配置,将对当前账号下自有设备的应用服务器以及开发者身份下其他应用相关的应用服务器同时起作用,所以可以一次性设置全。</p> </blockquote> <h2 id="6">6、输入飞印应用ID,开始使用飞印APP</h2> <h3>任何飞印用户都可以在自己的界面输入不同的飞印应用ID:</h3> <p><img src="https://www.showdoc.cc/server/api/common/visitfile/sign/93534c32b67ad545ea9edb315e211c7a?showdoc=.jpg" alt="输入飞印应用ID" title="输入飞印应用ID" /></p> <h3>确认授权,用户授权通过时,我们将发送用户的授权信息到开发者的回调地址。</h3> <p><img src="https://www.showdoc.cc/server/api/common/visitfile/sign/d1ad5bdc2868adf7f70522219102f665?showdoc=.jpg" alt="确认授权" title="确认授权" /></p> <h3>授权完成后,飞印设备管理界面将出现这个应用的图标,进入后就可以开始使用了。</h3> <p><img src="https://www.showdoc.cc/server/api/common/visitfile/sign/e58a91860675efc1ce23cbc7994a4442?showdoc=.jpg" alt="添加新应用" title="添加新应用" /></p> <h2 id="7">7、从飞印平台进入飞印应用的传参</h2> <p>当任意一个飞印用户从飞印平台打开飞印应用时,会进入应用在飞印平台注册的应用登录地址,同时会将当前的用户id和一个加密串作为额外参数附带在应用登录地址中,<strong>这样开发者就知道是哪一个用户进入了这个应用</strong>。</p> <p>其中secret的计算方式如下:</p> <p><strong>secret=md5(uid + time + APPKEY)</strong></p> <p><code>譬如,假设 uid=a2a25aae18ff11e8b361525400eebbbb, time = 1548133667624, APPKEY = abcd1234,那么加密出来的内容是 906585c7f3cb2b66c199c632c206113d</code></p> <p>当用户点击应用图标进入应用时,假设该应用的登录地址为 <a href="http://www.somesite.com/print/feyin">http://www.somesite.com/print/feyin</a> 那么其进入应用的最终请求地址为: <a href="https://www.somesite.com/print/feyin?uid=a2a25aae18ff11e8b361525400eebbbb&time=1548133667624&secret=906585c7f3cb2b66c199c632c206113d">https://www.somesite.com/print/feyin?uid=a2a25aae18ff11e8b361525400eebbbb&time=1548133667624&secret=906585c7f3cb2b66c199c632c206113d</a></p> <p><strong>应用需要从url中获取secret并用自己的APIKEY校验该请求的合法性。</strong></p>

页面列表

ITEM_HTML