UNPKG

fa-comm

Version:
193 lines (180 loc) 7.52 kB
<html> <head> <title>微信服务号服务器Api文档</title> </head> <style> group div { font-weight: bold; } table { width: 100%; border-top: solid 1px; } table tr:hover { background: #72d8b657; } .title { width: 20%; border-left: solid 1px; border-right: solid 1px; border-bottom: solid 1px; } .notes { border-right: solid 1px; border-bottom: solid 1px; } .red { color: red; } </style> <body> <group> <fieldset> <div>校验数据有效性</div> <table> <tr> <td class="title">Url</td> <td class="notes">/verification</td> </tr> <tr> <td class="title">Method</td> <td class="notes">POST</td> </tr> <tr> <td class="title">Params</td> <td class="notes"></td> </tr> <tr> <td class="title">Body</td> <td class="notes">待校验数据</td> </tr> <tr> <td class="title">Header</td> <td class="notes"></td> </tr> <tr> <td class="title">Returns</td> <td class="notes">如果校验成功,则返回实际结果,否则返回异常信息。如果校验失败或异常,一般是由于待校验数据不完整,或非本框架的推送,有些类似于微信的“接入指南-验证消息的确来自微信服务器”,只是我们是在接口端实现,这样第三方开发者不需要关心校验逻辑,只需调用一下接口,即可实现校验。</span></td> </tr> <tr> <td class="title">Notes</td> <td class="notes">用于本框架主动(目前有网页Oauth2.0授权和微信事件推送)推送给第三方开发者的内容进行有效性验证,注意:只有本框架主动推送给开发者的消息才需要验证,开发者主动调用本框架接口的返回值不需要验证。</td> </tr> </table> </fieldset> </group> <group> <fieldset> <div>获取AccessToken接口</div> <table> <tr> <td class="title">Url</td> <td class="notes">/</td> </tr> <tr> <td class="title">Method</td> <td class="notes">POST</td> </tr> <tr> <td class="title">Params</td> <td class="notes"></td> </tr> <tr> <td class="title">Body</td> <td class="notes"></td> </tr> <tr> <td class="title">Header</td> <td class="notes"> account_id:以"gh_"开头的微信号,且该公众号必须由本程序托管(即配置了accounts)<br>module:请固定传"basic"<br>command:请固定传"accesstoken" </td> </tr> <tr> <td class="title">Returns</td> <td class="notes">对应公众号的AccessToken</span></td> </tr> <tr> <td class="title">Notes</td> <td class="notes">用于第三方需要使用自己的微信接口调用凭证,保证了AccessToken只在本框架维护,防止多地维护起冲突。</td> </tr> </table> </fieldset> </group> <group> <fieldset> <div>获取网页Oauth2.0授权地址</div> <table> <tr> <td class="title">Url</td> <td class="notes">/</td> </tr> <tr> <td class="title">Method</td> <td class="notes">POST</td> </tr> <tr> <td class="title">Params</td> <td class="notes"></td> </tr> <tr> <td class="title">Body</td> <td class="notes"> JSON格式,如:<br>{<br>&nbsp;&nbsp;"url":"要跳转的地址,授权成功跳转之后,会在地址栏带上wui参数,代表微信用户信息,该参数,需要调用校验接口,获取其真实信息",<br>&nbsp;&nbsp;"type":"授权方式,snsapi_base或snsapi_userinfo,详见微信文档:https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/Wechat_webpage_authorization.html"<br>} </td> </tr> <tr> <td class="title">Header</td> <td class="notes"> account_id:以"gh_"开头的微信号,且该公众号必须由本程序托管(即配置了accounts)<br>module:请固定传"oauth"<br>command:请固定传"url" </td> </tr> <tr> <td class="title">Returns</td> <td class="notes">一个微信Oauth2.0的URL</span></td> </tr> <tr> <td class="title">Notes</td> <td class="notes">访问该Oauth2.0地址会触发微信Oauth2.0授权,同意授权(如有需要)后,将自动跳转到用户的页面。</td> </tr> </table> </fieldset> </group> <group> <fieldset> <div>长地址转短地址</div> <table> <tr> <td class="title">Url</td> <td class="notes">/</td> </tr> <tr> <td class="title">Method</td> <td class="notes">POST</td> </tr> <tr> <td class="title">Params</td> <td class="notes"></td> </tr> <tr> <td class="title">Body</td> <td class="notes">JSON格式,如:<br>{<br>&nbsp;&nbsp;"url":"要转换的地址"<br>}</td> </tr> <tr> <td class="title">Header</td> <td class="notes"> account_id:以"gh_"开头的微信号,且该公众号必须由本程序托管(即配置了accounts),也可以不加,系统默认自动选择一个托管的账号<br>module:请固定传"account"<br>command:请固定传"shorturl" </td> </tr> <tr> <td class="title">Returns</td> <td class="notes">一个转换后的短地址</span></td> </tr> <tr> <td class="title">Notes</td> <td class="notes"></td> </tr> </table> </fieldset> </group> </body> </html>