欢迎!这里是飞印API文档

飞印API文档描述、示例


获取access_token

<p>access_token是飞印开放平台的全局唯一接口调用凭据,飞印开放平台调用各接口时都需使用access_token。开发者需要进行妥善保存。access_token的有效期目前为2个小时,需定时刷新,重复获取将导致上次获取的access_token失效。</p> <p>飞印开放平台的API调用所需的access_token的使用及生成方式说明:</p> <p>1、建议飞印开放平台开发者使用中控服务器统一获取和刷新access_token,其他业务逻辑服务器所使用的access_token均来自于该中控服务器,不应该各自去刷新,否则容易造成冲突,导致access_token覆盖而影响业务;</p> <p>2、目前access_token的有效期通过返回的expire_in来传达,目前是7200秒之内的值。中控服务器需要根据这个有效时间提前去刷新新access_token。在刷新过程中,中控服务器可对外继续输出的老access_token,此时飞印开放平台会保证在5分钟内,新老access_token都可用,这保证了第三方业务的平滑过渡;</p> <p>3、access_token的有效时间可能会在未来有调整,所以中控服务器不仅需要内部定时主动刷新,还需要提供被动刷新access_token的接口,这样便于业务服务器在API调用获知access_token已超时的情况下,可以触发access_token的刷新流程。</p> <p>飞印开放平台可以使用MemberCode和ApiKey调用本接口来获取access_token。MemberCode和ApiKey可在“飞印开放平台-开发-基本配置”页中获得(需要已经成为开发者,且帐号没有异常状态)。<strong>调用接口时,请登录“飞印公众号-基本配置”提前将服务器IP地址添加到IP白名单中,否则将无法调用成功。</strong></p> <h3>接口调用请求说明</h3> <h4>请求URL:</h4> <ul> <li><code>https://api.open.feyin.net/token?code=MEMBERCODE&amp;secret=APIKEY&amp;appid=APPID</code></li> </ul> <h4>请求方式:</h4> <ul> <li>GET</li> </ul> <h4>参数:</h4> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th style="text-align: left;">说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">code</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td style="text-align: left;">飞印用户的商户编码membercode</td> </tr> <tr> <td style="text-align: left;">secret</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td style="text-align: left;">飞印用户的API密钥(在飞印公众号-API接口描述页面可以获取)appkey</td> </tr> <tr> <td style="text-align: left;">appid</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td style="text-align: left;">应用id,如果是开发者所开发的第三方应用来获取token,则需要带上应用id,以防止开发者的多个应用的token冲突</td> </tr> </tbody> </table> <h4>返回说明</h4> <p>正常情况下,飞印开放平台会返回下述JSON数据包给飞印开放平台:</p> <pre><code class="language-json">{"access_token":"ACCESS_TOKEN","expires_in":7200, "appid":"5a58867e0aca3027f742a4de"}</code></pre> <h5>参数说明</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th style="text-align: left;">说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">access_token</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td style="text-align: left;">获取到的凭证</td> </tr> <tr> <td style="text-align: left;">expires_in</td> <td style="text-align: left;">是</td> <td style="text-align: left;">number</td> <td style="text-align: left;">凭证有效时间,单位:秒</td> </tr> <tr> <td style="text-align: left;">appid</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td style="text-align: left;">应用id,如果请求中带有appid,则在这里返回相同值</td> </tr> </tbody> </table> <p>错误时飞印开放平台会返回错误码等信息,JSON数据包示例如下:</p> <pre><code class="language-json">{"errcode":40001,"errmsg":"invalid appid"}</code></pre> <h5>参数说明</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th style="text-align: left;">说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">errcode</td> <td style="text-align: left;">是</td> <td style="text-align: left;">number</td> <td style="text-align: left;">错误编码,详见&quot;errorcode说明&quot;</td> </tr> <tr> <td style="text-align: left;">errmsg</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td style="text-align: left;">错误详细说明,当errcode等于0时此值为空</td> </tr> </tbody> </table> <h5>errcode说明</h5> <table> <thead> <tr> <th style="text-align: left;">返回码</th> <th style="text-align: left;">说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">0</td> <td style="text-align: left;">请求成功</td> </tr> <tr> <td style="text-align: left;">40001</td> <td style="text-align: left;">code或者secret未提供,请开发者确认其正确性</td> </tr> <tr> <td style="text-align: left;">40011</td> <td style="text-align: left;">code不存在或者密钥错误</td> </tr> <tr> <td style="text-align: left;">40012</td> <td style="text-align: left;">调用接口的IP地址不在白名单中,请在接口IP白名单中进行设置</td> </tr> </tbody> </table>

页面列表

ITEM_HTML