云真机

API接口文档


获取Access token调用接口

<h1>1.简介</h1> <p>用户从已配置IP白名单的服务器,主动请求接口可完成: 1、发消息; 2、发群公告 3、拉取数据; 4、下发指令通知智域管家.云真机完成动作; 5、查询指令执行结果;</p> <p>请求接口,都需要用到统一的Access Token机制,以下为Access Token的获取流程。</p> <h1>2.流程</h1> <p>联系客服开通API权限后,用户可在用户后台&lt;a href=&quot;<a href="https://yzj.miaokol.com/setting/api&quot;&gt;API配置&lt;/a&gt;页面,填写服务器IP地址白名单,并查看获取对智域管家.云真机用户唯一的API参数(APPID、APP">https://yzj.miaokol.com/setting/api&quot;&gt;API配置&lt;/a&gt;页面,填写服务器IP地址白名单,并查看获取对智域管家.云真机用户唯一的API参数(APPID、APP</a> SECRET )。</p> <h1>3.Access Token 获取</h1> <p>Access Token的有效期通过字段expires_in返回,目前有效期时间为7200秒。Access Token在有效期内尽量复用,可根据有效时间提前刷新获取新的Access Token。在获知Access Token已超时的情况下,要触发重新申请Access Token以保障业务不受影响。</p> <h5>请求URL</h5> <ul> <li><code>https://oapi-yzj.miaokol.com/oauth/token</code></li> </ul> <h5>请求方式</h5> <ul> <li>POST</li> </ul> <h5>请求参数</h5> <ul> <li>json结构体,结构体描述如下:</li> </ul> <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;">app_id</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>创建的应用id</td> </tr> <tr> <td style="text-align: left;">app_secret</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>应用密钥</td> </tr> <tr> <td style="text-align: left;">grand_type</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>固定填&quot;client_credentials&quot;</td> </tr> </tbody> </table> <h5>请求示例</h5> <pre><code>POST /oauth/token HTTP/1.1 Host: oapi-yzj.miaokol.com Content-Type: application/json; charset=UTF-8 { &amp;quot;grand_type&amp;quot;: &amp;quot;client_credentials&amp;quot;, &amp;quot;app_id&amp;quot;: &amp;quot;12n2AsVZArKefJbuaE&amp;quot;, &amp;quot;app_secret&amp;quot;: &amp;quot;dFFtpAKJdjjkAlQTumdcjzHtgzGyvFdb&amp;quot; } </code></pre> <h5>响应示例</h5> <pre><code>HTTP/1.1 200 OK Content-Type: application/json; charset=UTF-8 { &amp;quot;data&amp;quot;: { &amp;quot;access_token&amp;quot;: &amp;quot;2550fae1f260f21489ceaed103ec472d&amp;quot;, &amp;quot;expires_in&amp;quot;: 7200 }, &amp;quot;errcode&amp;quot;: 0 }</code></pre> <h5>响应说明</h5> <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;">access_token</td> <td style="text-align: left;">string</td> <td>Access Token</td> </tr> <tr> <td style="text-align: left;">expires_in</td> <td style="text-align: left;">int</td> <td>过期时间,单位为秒</td> </tr> </tbody> </table> <h3>刷新token</h3> <p>在Access Token过期之前可以通过Access Token进行刷新。</p> <h5>请求URL</h5> <ul> <li><code>https://oapi-yzj.miaokol.com/oauth/token</code></li> </ul> <h5>请求方式</h5> <ul> <li>POST</li> </ul> <h5>请求参数</h5> <ul> <li>json结构体,结构体描述如下:</li> </ul> <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;">app_id</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>创建的应用id</td> </tr> <tr> <td style="text-align: left;">access_token</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>Access Token</td> </tr> <tr> <td style="text-align: left;">grand_type</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>固定填&quot;refresh_token&quot;</td> </tr> </tbody> </table> <h5>请求示例</h5> <pre><code>POST /oauth/token HTTP/1.1 Host: oapi-yzj.miaokol.com Content-Type: application/json; charset=UTF-8 { &amp;quot;grand_type&amp;quot;: &amp;quot;refresh_token&amp;quot;, &amp;quot;app_id&amp;quot;: &amp;quot;44n2AsVZArKefJbuaE&amp;quot;, &amp;quot;access_token&amp;quot;: &amp;quot;452bb1677adc2724b5f80d18088206ff&amp;quot; } </code></pre> <h5>响应示例</h5> <pre><code>HTTP/1.1 200 OK Content-Type: application/json; charset=UTF-8 { &amp;quot;data&amp;quot;: { &amp;quot;access_token&amp;quot;: &amp;quot;2550fae1f260f21489ceaed103ec472d&amp;quot;, &amp;quot;expires_in&amp;quot;: 7200 }, &amp;quot;errcode&amp;quot;: 0 }</code></pre> <h5>响应说明</h5> <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;">access_token</td> <td style="text-align: left;">string</td> <td>Access Token</td> </tr> <tr> <td style="text-align: left;">expires_in</td> <td style="text-align: left;">int</td> <td>过期时间,单位为秒</td> </tr> </tbody> </table> <h1>4.点击跳至:&lt;a href=&quot;<a href="https://www.showdoc.com.cn/qybopen/7988266051228686&quot;&gt;已开放接口文档&lt;/a&gt">https://www.showdoc.com.cn/qybopen/7988266051228686&quot;&gt;已开放接口文档&lt;/a&gt</a>;</h1>

页面列表

ITEM_HTML