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

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


导入生成应用

<p><strong>简要描述:</strong> </p> <ul> <li>应用导入,操作步骤如下: <ol> <li>先通过调用 [上传媒体文件](<a href="https://www.showdoc.com.cn/mingdao/10150176877615973">https://www.showdoc.com.cn/mingdao/10150176877615973</a> &quot;上传媒体文件&quot;) 接口,上传要导入的mdy文件,获取到文件唯一标识media_id</li> <li>再调用应用导入接口,传入获取到的media_id及相关信息</li> </ol></li> </ul> <p><strong>请求URL:</strong> </p> <ul> <li><code>{Host}/v1/open/app/Import</code></li> </ul> <p><strong>请求方式:</strong></p> <ul> <li>POST (application/json) </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;">media_id</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>媒体文件上传后获取的唯一标识</td> </tr> <tr> <td style="text-align: left;">ownerId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>应用拥有者明道云账号Id</td> </tr> <tr> <td style="text-align: left;">callback</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>回调信息,用于接收文件导入的状态变更回调消息,实时了解文件导入的进度与结果。&lt;br&gt;格式如下:必须为HTTP/HTTPS支持POST请求的公网可访问的地址,不能携带任何参数。&lt;br&gt;{&lt;br&gt;&quot;appId&quot;:&quot;string&quot;,&lt;br&gt;&quot;name&quot;:&quot;string&quot;,&lt;br&gt;&quot;error_code&quot;: 1,&lt;br&gt;&quot;success&quot;: true,&lt;br&gt;&quot;error_msg&quot;: &quot;错误描述&quot;,&lt;br&gt;&quot;error_code&quot;: 10101&lt;br&gt;}</td> </tr> <tr> <td style="text-align: left;">groupIds</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string[]</td> <td>应用分组id集合</td> </tr> <tr> <td style="text-align: left;">password</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>应用导入密码,应用导入需要密码时填入</td> </tr> <tr> <td style="text-align: left;">matchOffice</td> <td style="text-align: left;">否</td> <td style="text-align: left;">bool</td> <td>是否匹配人员部门职位,默认为true,匹配:true,不匹配:false</td> </tr> </tbody> </table> <p><strong>提交数据示例</strong></p> <pre><code>{ &amp;quot;projectId&amp;quot;: &amp;quot;string&amp;quot;, &amp;quot;ownerId&amp;quot;: &amp;quot;string&amp;quot;, &amp;quot;timestamp&amp;quot;: 1685089834029, &amp;quot;mediaId&amp;quot;: &amp;quot;string&amp;quot;, &amp;quot;callback&amp;quot;: &amp;quot;string&amp;quot;, &amp;quot;groupIds&amp;quot;: [&amp;quot;string&amp;quot;], &amp;quot;password&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;matchOffice&amp;quot;: true, &amp;quot;appKey&amp;quot;: &amp;quot;string&amp;quot;, &amp;quot;sign&amp;quot;: &amp;quot;string&amp;quot; }</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;">data</td> <td style="text-align: left;">App</td> <td>应用对象</td> </tr> <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> </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> </tbody> </table> <p><strong>成功</strong></p> <pre><code>{ &amp;quot;data&amp;quot;: &amp;quot;3f3ae234-5faf-4250-896f-9da983510d99&amp;quot;, &amp;quot;success&amp;quot;: true, &amp;quot;error_code&amp;quot;: 1 }</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