明道企业授权开放接口文档

明道企业授权开放接口文档


获取应用列表

<p><strong>简要描述:</strong> </p> <ul> <li>获取应用列表</li> </ul> <p><strong>请求URL:</strong> </p> <ul> <li><code>{Host}/v1/open/app/getByProject</code></li> </ul> <p><strong>请求方式:</strong></p> <ul> <li>GET</li> </ul> <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;">accountId</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>明道云账号Id(不为空表示获取特定用户加入的应用,为空则获取组织下所有应用)</td> </tr> </tbody> </table> <p><strong>请求示例</strong></p> <pre><code>${Host}/v1/open/app/getByProject?timestamp=1618837301125&amp;amp;projectId=449abe0c-e014-4836-8b60-d868c217599c&amp;amp;appKey=ak&amp;amp;sign=x&amp;amp;accountId=id</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;">success</td> <td style="text-align: left;">bool</td> <td>操作是否成功</td> </tr> <tr> <td style="text-align: left;">error_code</td> <td style="text-align: left;">int</td> <td>错误代码,1代表成功</td> </tr> <tr> <td style="text-align: left;">error_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;">App[]</td> <td>应用集合</td> </tr> </tbody> </table> <p>App 实体:</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;">appId</td> <td style="text-align: left;">string</td> <td>应用Id</td> </tr> <tr> <td style="text-align: left;">name</td> <td style="text-align: left;">string</td> <td>应用名称</td> </tr> <tr> <td style="text-align: left;">iconUrl</td> <td style="text-align: left;">string</td> <td>图标链接,svg 类型</td> </tr> <tr> <td style="text-align: left;">color</td> <td style="text-align: left;">string</td> <td>图标颜色</td> </tr> <tr> <td style="text-align: left;">ownerId</td> <td style="text-align: left;">string</td> <td>拥有者账号Id</td> </tr> <tr> <td style="text-align: left;">createType</td> <td style="text-align: left;">int</td> <td>应用类型 0 = 常规应用,1 = 外部链接应用</td> </tr> <tr> <td style="text-align: left;">urlTemplate</td> <td style="text-align: left;">string</td> <td>链接</td> </tr> </tbody> </table> <p><strong>成功</strong></p> <pre><code>{ &amp;quot;data&amp;quot;: [{ &amp;quot;appId&amp;quot;:&amp;quot;string&amp;quot;, &amp;quot;name&amp;quot;:&amp;quot;string&amp;quot;, &amp;quot;iconUrl&amp;quot;:&amp;quot;string&amp;quot;, &amp;quot;color&amp;quot;:&amp;quot;string&amp;quot;, &amp;quot;ownerId&amp;quot;:&amp;quot;string&amp;quot;, &amp;quot;createType&amp;quot;:int, &amp;quot;urlTemplate&amp;quot;:&amp;quot;string&amp;quot;, }], &amp;quot;error_code&amp;quot;:1, &amp;quot;success&amp;quot;: true }</code></pre> <p><strong>失败</strong></p> <pre><code>{ &amp;quot;error_msg&amp;quot;: &amp;quot;错误描述&amp;quot;, &amp;quot;error_code&amp;quot;: 10101, //状态码 非1为失败, &amp;quot;success&amp;quot;: false }</code></pre>

页面列表

ITEM_HTML