openapi

鉴权流程

获取 AccessToken

基本信息

Path: /openapi/v1/organization/application/token

Method: POST

接口描述:

- 访问openapi/v1路径下接口时,需要将本接口获取的加入到headers参数中:
    - X-MG-Authentication :

请求参数

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json

Body

名称类型是否必须默认值备注其他信息
app_idstring非必须需要企业管理员在企业管理后台的应用管理界面界面获取
app_secretstring非必须app_id对应的serect

返回数据

名称类型是否必须默认值备注其他信息
codestring非必须
dataobject非必须
├─ expirenumber非必须token剩余可用时间,单位秒
├─ tokenstring非必须用于其他接口的鉴权
metaobject非必须
├─ timenumber非必须
├─ tracestring非必须

用户信息

获取用户信息

基本信息

Path: /openapi/v1/users/:userId

Method: GET

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
X-MG-Authentication

路径参数

参数名称示例备注
userId

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
dataobject必须
├─ idnumber必须
├─ namestring必须
├─ emailstring必须
├─ avatarstring必须
metaobject必须
├─ timenumber必须
├─ tracestring必须

项目信息

获取用户项目列表

基本信息

Path: /openapi/v1/users/:userId/projects

Method: GET

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
X-MG-Authentication

路径参数

参数名称示例备注
userId

Query

参数名称是否必须示例备注
teamId团队 id

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
dataobject []必须

item 类型: object

├─ createdAtstring非必须
├─ idnumber非必须
├─ namestring非必须
├─ updatedAtstring非必须
metaobject必须
├─ timenumber必须
├─ tracestring必须
msgstring必须

文件信息

删除文件到回收站

基本信息

Path: /openapi/v1/users/:userId/document

Method: DELETE

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json
X-MG-Authentication

路径参数

参数名称示例备注
userId

Query

参数名称是否必须示例备注
documentId

Body

名称类型是否必须默认值备注其他信息

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
dataobject非必须
metaobject非必须
├─ timestring必须
├─ tracestring必须
msgstring必须

批量获取文件详情信息

基本信息

Path: /openapi/v1/documents

Method: POST

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json
X-MG-Authentication

Body

名称类型是否必须默认值备注其他信息
idsnumber []必须文档id列表(最多支持100个)

item 类型: number

├─非必须

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
dataobject []必须

item 类型: object

├─ createdAtstring非必须
├─ creatorIdnumber非必须
├─ idnumber非必须
├─ namestring非必须
├─ ownerIdnumber非必须
├─ typenumber非必须
├─ coverstring非必须封面
├─ coverBGColorstring非必须文档封面背景色
├─ updatedAtstring非必须
metaobject必须
├─ timenumber必须
├─ tracestring必须
msgstring必须

用户新建文件

基本信息

Path: /openapi/v1/users/:userId/document

Method: POST

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json
X-MG-Authentication

路径参数

参数名称示例备注
userId

Body

名称类型是否必须默认值备注其他信息
projectIdnumber非必须项目id(不传默认建到草稿箱)
namestring非必须文件名

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
metaobject非必须
├─ timestring非必须
├─ tracestring非必须
dataobject非必须
msgstring非必须

获取用户文件列表

基本信息

Path: /openapi/v1/users/:userId/documents

Method: GET

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
X-MG-Authentication

路径参数

参数名称示例备注
userId

Query

参数名称是否必须示例备注
projectId项目 id(不传默认获取草稿箱文件)

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
dataobject []必须

item 类型: object

├─ createdAtstring非必须
├─ creatorIdnumber非必须
├─ idnumber非必须
├─ namestring非必须
├─ ownerIdnumber非必须
├─ typenumber非必须
├─ coverstring非必须封面
├─ coverBGColorstring非必须文档封面背景色
├─ updatedAtstring非必须
metaobject必须
├─ timenumber必须
├─ tracestring必须
msgstring必须

团队库

获取该文件下所有已经发布的内容

基本信息

Path: /openapi/v1/document/:documentId/library

Method: GET

接口描述:

- 后续重复结构,不再给出备注信息

请求参数

Headers

参数名称参数值是否必须示例备注
X-MG-Authentication值为鉴权 token 接口获取到的 token

路径参数

参数名称示例备注
documentId79932944518710文件 id

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
dataobject []必须

item 类型: object

├─ documentIdnumber非必须文件ID
├─ documentNamestring非必须文件名称
├─ projectIdnumber非必须项目ID
├─ teamIdnumber非必须团队ID
├─ creatorobject非必须文件创建者信息
├─ idnumber非必须用户id
├─ namestring非必须用户名称
├─ avatarstring非必须用户头像链接
├─ createdAtstring非必须文件创建时间
├─ updatedAtstring非必须文件最后更新时间
├─ publishedScopestring非必须发布范围,发布到当前团队:team; 发布到多团队:multiTeam; 发布到企业:orgnization.
├─ componentsobject []非必须组件信息

item 类型: object

├─ ukeystring非必须组件唯一标识
├─ documentIdnumber非必须组件所属的文件id
├─ layerIdstring非必须组件所属图层id
├─ namestring非必须组件名称
├─ coverstring非必须组件缩略图地址
├─ descriptionstring非必须描述
├─ componentSetUkeystring非必须组件所属的组件集唯一标识,当组件集不存在时为空
├─ lastUpdatorobject非必须最后一个更新者信息
├─ idnumber非必须
├─ namestring非必须
├─ avatarstring非必须
├─ pageInfoobject非必须组件所属页面信息
├─ pageIdstring非必须页面id
├─ pageNamestring非必须页面名称
├─ layerIdstring非必须图层id
├─ frameNamestring非必须容器名称
├─ backgroundColorstring非必须背景颜色
├─ createdAtstring非必须组件创建时间
├─ updatedAtstring非必须组件最后更新时间
├─ componentSetsobject []非必须组件集信息

item 类型: object

├─ ukeystring非必须组件集唯一标识
├─ documentIdnumber非必须
├─ layerIdstring非必须
├─ namestring非必须
├─ coverstring非必须
├─ descriptionstring非必须
├─ lastUpdatorobject非必须
├─ idnumber非必须
├─ namestring非必须
├─ avatarstring非必须
├─ pageInfoobject非必须
├─ pageIdstring非必须
├─ pageNamestring非必须
├─ layerIdstring非必须
├─ frameNamestring非必须
├─ backgroundColorstring非必须
├─ createdAtstring非必须
├─ updatedAtstring非必须
├─ stylesobject []非必须

item 类型: object

├─ ukeystring非必须
├─ documentIdnumber非必须
├─ namestring非必须
├─ coverstring非必须
├─ descriptionstring非必须
├─ styleTypestring非必须样式类型
├─ sortIndexstring非必须排序标识
├─ styleSubTypenumber非必须样式子类型
├─ lastUpdatorobject非必须
├─ idnumber非必须
├─ namestring非必须
├─ avatarstring非必须
├─ createdAtstring非必须
├─ updatedAtstring非必须
metaobject必须
├─ timenumber必须
├─ tracestring必须
msgstring必须

获取该团队下所有已经发布的内容

基本信息

Path: /openapi/v1/team/:teamId/libraries

Method: GET

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
X-MG-Authentication

路径参数

参数名称示例备注
teamId79932816592431团队 id

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
dataobject []必须

item 类型: object

├─ documentIdnumber非必须
├─ documentNamestring非必须
├─ projectIdnumber非必须
├─ teamIdnumber非必须
├─ creatorobject非必须
├─ idnumber非必须
├─ namestring非必须
├─ avatarstring非必须
├─ createdAtstring非必须
├─ updatedAtstring非必须
├─ publishedScopestring非必须
├─ componentsobject []非必须

item 类型: object

├─ ukeystring非必须
├─ documentIdnumber非必须
├─ layerIdstring非必须
├─ namestring非必须
├─ coverstring非必须
├─ descriptionstring非必须
├─ componentSetUkeystring非必须
├─ lastUpdatorobject非必须
├─ idnumber非必须
├─ namestring非必须
├─ avatarstring非必须
├─ pageInfoobject非必须
├─ pageIdstring非必须
├─ pageNamestring非必须
├─ layerIdstring非必须
├─ frameNamestring非必须
├─ backgroundColorstring非必须
├─ createdAtstring非必须
├─ updatedAtstring非必须
├─ componentSetsobject []非必须

item 类型: object

├─ ukeystring非必须
├─ documentIdnumber非必须
├─ layerIdstring非必须
├─ namestring非必须
├─ coverstring非必须
├─ descriptionstring非必须
├─ lastUpdatorobject非必须
├─ idnumber非必须
├─ namestring非必须
├─ avatarstring非必须
├─ pageInfoobject非必须
├─ pageIdstring非必须
├─ pageNamestring非必须
├─ layerIdstring非必须
├─ frameNamestring非必须
├─ backgroundColorstring非必须
├─ createdAtstring非必须
├─ updatedAtstring非必须
├─ stylesobject []非必须

item 类型: object

├─ ukeystring非必须
├─ documentIdnumber非必须
├─ namestring非必须
├─ coverstring非必须
├─ descriptionstring非必须
├─ styleTypestring非必须
├─ sortIndexstring非必须
├─ styleSubTypenumber非必须
├─ lastUpdatorobject非必须
├─ idnumber非必须
├─ namestring非必须
├─ avatarstring非必须
├─ createdAtstring非必须
├─ updatedAtstring非必须
metaobject必须
├─ timenumber必须
├─ tracestring必须
msgstring必须

获取文件下已经发布的组件详情

基本信息

Path: /openapi/v1/document/:documentId/components

Method: GET

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
X-MG-Authentication

路径参数

参数名称示例备注
documentId

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
dataobject []必须

item 类型: object

├─ ukeystring非必须
├─ documentIdnumber非必须
├─ layerIdstring非必须
├─ namestring非必须
├─ coverstring非必须
├─ descriptionstring非必须
├─ componentSetUkeystring非必须
├─ lastUpdatorobject非必须
├─ idnumber非必须
├─ namestring非必须
├─ avatarstring非必须
├─ pageInfoobject非必须
├─ pageIdstring非必须
├─ pageNamestring非必须
├─ layerIdstring非必须
├─ frameNamestring非必须
├─ backgroundColorstring非必须
├─ createdAtstring非必须
├─ updatedAtstring非必须
metaobject必须
├─ timenumber必须
├─ tracestring必须
msgstring必须

获取文件下已经发布的组件集详情

基本信息

Path: /openapi/v1/document/:documentId/componentSets

Method: GET

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
X-MG-Authentication

路径参数

参数名称示例备注
documentId

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
dataobject []必须

item 类型: object

├─ ukeystring非必须
├─ documentIdnumber非必须
├─ layerIdstring非必须
├─ namestring非必须
├─ coverstring非必须
├─ descriptionstring非必须
├─ lastUpdatorobject非必须
├─ idnumber非必须
├─ namestring非必须
├─ avatarstring非必须
├─ pageInfoobject非必须
├─ pageIdstring非必须
├─ pageNamestring非必须
├─ layerIdstring非必须
├─ frameNamestring非必须
├─ backgroundColorstring非必须
├─ createdAtstring非必须
├─ updatedAtstring非必须
metaobject必须
├─ timenumber必须
├─ tracestring必须
msgstring必须

获取文件下已经发布的样式详情

基本信息

Path: /openapi/v1/document/:documentId/styles

Method: GET

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
X-MG-Authentication

路径参数

参数名称示例备注
documentId

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
dataobject []必须

item 类型: object

├─ ukeystring非必须
├─ documentIdnumber非必须
├─ namestring非必须
├─ coverstring非必须
├─ descriptionstring非必须
├─ styleTypestring非必须
├─ sortIndexstring非必须
├─ styleSubTypenumber非必须
├─ lastUpdatorobject非必须
├─ idnumber非必须
├─ namestring非必须
├─ avatarstring非必须
├─ createdAtstring非必须
├─ updatedAtstring非必须
metaobject必须
├─ timenumber必须
├─ tracestring必须
msgstring必须

获取团队下所有组件详情

基本信息

Path: /openapi/v1/team/:teamId/components

Method: GET

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
X-MG-Authentication

路径参数

参数名称示例备注
teamId

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
dataobject []必须

item 类型: object

├─ ukeystring非必须
├─ documentIdnumber非必须
├─ layerIdstring非必须
├─ namestring非必须
├─ coverstring非必须
├─ descriptionstring非必须
├─ componentSetUkeystring非必须
├─ lastUpdatorobject非必须
├─ idnumber非必须
├─ namestring非必须
├─ avatarstring非必须
├─ pageInfoobject非必须
├─ pageIdstring非必须
├─ pageNamestring非必须
├─ layerIdstring非必须
├─ frameNamestring非必须
├─ backgroundColorstring非必须
├─ createdAtstring非必须
├─ updatedAtstring非必须
metaobject必须
├─ timenumber必须
├─ tracestring必须
msgstring必须

获取团队下已经发布的组件集详情

基本信息

Path: /openapi/v1/team/:teamId/componentSets

Method: GET

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
X-MG-Authentication

路径参数

参数名称示例备注
teamId

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
dataobject []必须

item 类型: object

├─ ukeystring非必须
├─ documentIdnumber非必须
├─ layerIdstring非必须
├─ namestring非必须
├─ coverstring非必须
├─ descriptionstring非必须
├─ lastUpdatorobject非必须
├─ idnumber非必须
├─ namestring非必须
├─ avatarstring非必须
├─ pageInfoobject非必须
├─ pageIdstring非必须
├─ pageNamestring非必须
├─ layerIdstring非必须
├─ frameNamestring非必须
├─ backgroundColorstring非必须
├─ createdAtstring非必须
├─ updatedAtstring非必须
metaobject必须
├─ timenumber必须
├─ tracestring必须
msgstring必须

获取团队下已经发布的样式详情

基本信息

Path: /openapi/v1/team/:teamId/styles

Method: GET

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
X-MG-Authentication

路径参数

参数名称示例备注
teamId

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
dataobject []必须

item 类型: object

├─ ukeystring非必须
├─ documentIdnumber非必须
├─ namestring非必须
├─ coverstring非必须
├─ descriptionstring非必须
├─ styleTypestring非必须
├─ sortIndexstring非必须
├─ styleSubTypenumber非必须
├─ lastUpdatorobject非必须
├─ idnumber非必须
├─ namestring非必须
├─ avatarstring非必须
├─ createdAtstring非必须
├─ updatedAtstring非必须
metaobject必须
├─ timenumber必须
├─ tracestring必须
msgstring必须

获取特定组件详情

基本信息

Path: /openapi/v1/component

Method: GET

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
X-MG-Authentication

Query

参数名称是否必须示例备注
ukey79932944518710%2B79%3A2ukey 是组件、组件集、样式的唯一标识,请求时需要对 ukey 进行 url-encode

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
dataobject必须
├─ ukeystring非必须
├─ documentIdnumber非必须
├─ layerIdstring非必须
├─ namestring非必须
├─ coverstring非必须
├─ descriptionstring非必须
├─ componentSetUkeystring非必须
├─ lastUpdatorobject非必须
├─ idnumber非必须
├─ namestring非必须
├─ avatarstring非必须
├─ pageInfoobject非必须
├─ pageIdstring非必须
├─ pageNamestring非必须
├─ layerIdstring非必须
├─ frameNamestring非必须
├─ backgroundColorstring非必须
├─ createdAtstring非必须
├─ updatedAtstring非必须
metaobject必须
├─ timenumber必须
├─ tracestring必须
msgstring必须

获取特定组件集详情

基本信息

Path: /openapi/v1/componentSet

Method: GET

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
X-MG-Authentication

Query

参数名称是否必须示例备注
ukey79932944518710%2B81%3A8需要对 ukey 进行 url-encode

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
dataobject必须
├─ ukeystring非必须
├─ documentIdnumber非必须
├─ layerIdstring非必须
├─ namestring非必须
├─ coverstring非必须
├─ descriptionstring非必须
├─ lastUpdatorobject非必须
├─ idnumber非必须
├─ namestring非必须
├─ avatarstring非必须
├─ pageInfoobject非必须
├─ pageIdstring非必须
├─ pageNamestring非必须
├─ layerIdstring非必须
├─ frameNamestring非必须
├─ backgroundColorstring非必须
├─ createdAtstring非必须
├─ updatedAtstring非必须
metaobject必须
├─ timenumber必须
├─ tracestring必须
msgstring必须

获取特定样式详情

基本信息

Path: /openapi/v1/style

Method: GET

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
X-MG-Authentication

Query

参数名称是否必须示例备注
ukey79932944518710%2B79%3A2需要对 ukey 进行 url-encode

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
dataobject必须
├─ ukeystring非必须
├─ documentIdnumber非必须
├─ namestring非必须
├─ coverstring非必须
├─ descriptionstring非必须
├─ styleTypestring非必须
├─ sortIndexstring非必须
├─ styleSubTypenumber非必须
├─ lastUpdatorobject非必须
├─ idnumber非必须
├─ namestring非必须
├─ avatarstring非必须
├─ createdAtstring非必须
├─ updatedAtstring非必须
metaobject必须
├─ timenumber必须
├─ tracestring必须
msgstring必须

团队信息

获取企业下团队

基本信息

Path: /openapi/v1/organization/teams

Method: GET

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
X-MG-Authentication

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
dataobject []必须

item 类型: object

├─ createdAtstring非必须
├─ descriptionnull,string非必须
├─ idnumber非必须
├─ logostring非必须
├─ namestring非必须
├─ ownerIdnumber非必须
├─ updatedAtstring非必须
metaobject必须
├─ timenumber必须
├─ tracestring必须
msgstring必须

获取用户团队列表

基本信息

Path: /openapi/v1/users/:userId/teams

Method: GET

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
X-MG-Authentication

路径参数

参数名称示例备注
userId

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
dataobject []必须

item 类型: object

├─ createdAtstring非必须
├─ descriptionnull,string非必须
├─ idnumber非必须
├─ logostring非必须
├─ namestring非必须
├─ ownerIdnumber非必须
├─ updatedAtstring非必须
metaobject必须
├─ timenumber必须
├─ tracestring必须
msgstring必须

获取团队下项目

基本信息

Path: /openapi/v1/team/:teamId/projects

Method: GET

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
X-MG-Authentication

路径参数

参数名称示例备注
teamId

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
dataobject []必须

item 类型: object

├─ createdAtstring非必须
├─ idnumber非必须
├─ namestring非必须
├─ updatedAtstring非必须
metaobject必须
├─ timenumber必须
├─ tracestring必须
msgstring必须

获取团队下文件

基本信息

Path: /openapi/v1/team/:teamId/documents

Method: GET

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
X-MG-Authentication

路径参数

参数名称示例备注
teamId

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
dataobject []必须

item 类型: object

├─ createdAtstring非必须
├─ creatorIdnumber非必须
├─ idnumber非必须
├─ namestring非必须
├─ ownerIdnumber非必须
├─ typenumber非必须文件类型
├─ updatedAtstring非必须
metaobject必须
├─ timenumber必须
├─ tracestring必须
msgstring必须

获取项目下文件

基本信息

Path: /openapi/v1/project/:projectId/documents

Method: GET

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
X-MG-Authentication

路径参数

参数名称示例备注
projectId

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
dataobject []必须

item 类型: object

├─ createdAtstring非必须
├─ creatorIdnumber非必须
├─ idnumber非必须
├─ namestring非必须
├─ ownerIdnumber非必须
├─ typenumber非必须
├─ updatedAtstring非必须
metaobject必须
├─ timenumber必须
├─ tracestring必须
msgstring必须

获取团队下已经发布的文件

基本信息

Path: /openapi/v1/team/:teamId/lib/documents

Method: GET

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
X-MG-Authentication

路径参数

参数名称示例备注
teamId

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
dataobject []必须

item 类型: object

├─ createdAtstring非必须
├─ creatorIdnumber非必须
├─ idnumber非必须
├─ libraryIdstring非必须
├─ namestring非必须
├─ ownerIdnumber非必须
├─ typenumber非必须
├─ updatedAtstring非必须
metaobject必须
├─ timenumber必须
├─ tracestring必须
msgstring必须

获取项目下已经发布的文件

基本信息

Path: /openapi/v1/project/:projectId/lib/documents

Method: GET

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
X-MG-Authentication

路径参数

参数名称示例备注
projectId

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
dataobject []必须

item 类型: object

├─ createdAtstring非必须
├─ creatorIdnumber非必须
├─ idnumber非必须
├─ libraryIdstring非必须
├─ namestring非必须
├─ ownerIdnumber非必须
├─ typenumber非必须
├─ updatedAtstring非必须
metaobject必须
├─ timenumber必须
├─ tracestring必须
msgstring必须

其他

根据 userCode 获取用户 id

基本信息

Path: /openapi/v1/user

Method: GET

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
X-MG-Authentication

Query

参数名称是否必须示例备注
userCodexxxxxxx

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
dataobject必须
├─ userIdnumber必须MG用户id
metaobject必须
├─ tracestring必须
├─ timestring必须