openapi
鉴权流程
获取 AccessToken
基本信息
Path: /openapi/v1/organization/application/token
Method: POST
接口描述:
- 访问openapi/v1路径下接口时,需要将本接口获取的加入到headers参数中:
- X-MG-Authentication :
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
app_id | string | 非必须 | 需要企业管理员在企业管理后台的应用管理界面界面获取 | ||
app_secret | string | 非必须 | app_id对应的serect |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | string | 非必须 | |||
data | object | 非必须 | |||
├─ expire | number | 非必须 | token剩余可用时间,单位秒 | ||
├─ token | string | 非必须 | 用于其他接口的鉴权 | ||
meta | object | 非必须 | |||
├─ time | number | 非必须 | |||
├─ trace | string | 非必须 |
用户信息
获取用户信息
基本信息
Path: /openapi/v1/users/:userId
Method: GET
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
X-MG-Authentication | 是 |
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
userId |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | string | 必须 | |||
data | object | 必须 | |||
├─ id | number | 必须 | |||
├─ name | string | 必须 | |||
string | 必须 | ||||
├─ avatar | string | 必须 | |||
meta | object | 必须 | |||
├─ time | number | 必须 | |||
├─ trace | string | 必须 |
项目信息
获取用户项目列表
基本信息
Path: /openapi/v1/users/:userId/projects
Method: GET
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
X-MG-Authentication | 是 |
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
userId |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
teamId | 是 | 团队 id |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | string | 必须 | |||
data | object [] | 必须 | item 类型: object | ||
├─ createdAt | string | 非必须 | |||
├─ id | number | 非必须 | |||
├─ name | string | 非必须 | |||
├─ updatedAt | string | 非必须 | |||
meta | object | 必须 | |||
├─ time | number | 必须 | |||
├─ trace | string | 必须 | |||
msg | string | 必须 |
文件信息
删除文件到回收站
基本信息
Path: /openapi/v1/users/:userId/document
Method: DELETE
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
X-MG-Authentication | 是 |
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
userId |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
documentId | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | string | 必须 | |||
data | object | 非必须 | |||
meta | object | 非必须 | |||
├─ time | string | 必须 | |||
├─ trace | string | 必须 | |||
msg | string | 必须 |
批量获取文件详情信息
基本信息
Path: /openapi/v1/documents
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
X-MG-Authentication | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
ids | number [] | 必须 | 文档id列表(最多支持100个) | item 类型: number | |
├─ | 非必须 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | string | 必须 | |||
data | object [] | 必须 | item 类型: object | ||
├─ createdAt | string | 非必须 | |||
├─ creatorId | number | 非必须 | |||
├─ id | number | 非必须 | |||
├─ name | string | 非必须 | |||
├─ ownerId | number | 非必须 | |||
├─ type | number | 非必须 | |||
├─ cover | string | 非必须 | 封面 | ||
├─ coverBGColor | string | 非必须 | 文档封面背景色 | ||
├─ updatedAt | string | 非必须 | |||
meta | object | 必须 | |||
├─ time | number | 必须 | |||
├─ trace | string | 必须 | |||
msg | string | 必须 |
用户新建文件
基本信息
Path: /openapi/v1/users/:userId/document
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | ||
X-MG-Authentication | 是 |
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
userId |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
projectId | number | 非必须 | 项目id(不传默认建到草稿箱) | ||
name | string | 非必须 | 文件名 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | string | 必须 | |||
meta | object | 非必须 | |||
├─ time | string | 非必须 | |||
├─ trace | string | 非必须 | |||
data | object | 非必须 | |||
msg | string | 非必须 |
获取用户文件列表
基本信息
Path: /openapi/v1/users/:userId/documents
Method: GET
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
X-MG-Authentication | 是 |
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
userId |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
projectId | 否 | 项目 id(不传默认获取草稿箱文件) |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | string | 必须 | |||
data | object [] | 必须 | item 类型: object | ||
├─ createdAt | string | 非必须 | |||
├─ creatorId | number | 非必须 | |||
├─ id | number | 非必须 | |||
├─ name | string | 非必须 | |||
├─ ownerId | number | 非必须 | |||
├─ type | number | 非必须 | |||
├─ cover | string | 非必须 | 封面 | ||
├─ coverBGColor | string | 非必须 | 文档封面背景色 | ||
├─ updatedAt | string | 非必须 | |||
meta | object | 必须 | |||
├─ time | number | 必须 | |||
├─ trace | string | 必须 | |||
msg | string | 必须 |
团队库
获取该文件下所有已经发布的内容
基本信息
Path: /openapi/v1/document/:documentId/library
Method: GET
接口描述:
- 后续重复结构,不再给出备注信息
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
X-MG-Authentication | 是 | 值为鉴权 token 接口获取到的 token |
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
documentId | 79932944518710 | 文件 id |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | string | 必须 | |||
data | object [] | 必须 | item 类型: object | ||
├─ documentId | number | 非必须 | 文件ID | ||
├─ documentName | string | 非必须 | 文件名称 | ||
├─ projectId | number | 非必须 | 项目ID | ||
├─ teamId | number | 非必须 | 团队ID | ||
├─ creator | object | 非必须 | 文件创建者信息 | ||
├─ id | number | 非必须 | 用户id | ||
├─ name | string | 非必须 | 用户名称 | ||
├─ avatar | string | 非必须 | 用户头像链接 | ||
├─ createdAt | string | 非必须 | 文件创建时间 | ||
├─ updatedAt | string | 非必须 | 文件最后更新时间 | ||
├─ publishedScope | string | 非必须 | 发布范围,发布到当前团队:team; 发布到多团队:multiTeam; 发布到企业:orgnization. | ||
├─ components | object [] | 非必须 | 组件信息 | item 类型: object | |
├─ ukey | string | 非必须 | 组件唯一标识 | ||
├─ documentId | number | 非必须 | 组件所属的文件id | ||
├─ layerId | string | 非必须 | 组件所属图层id | ||
├─ name | string | 非必须 | 组件名称 | ||
├─ cover | string | 非必须 | 组件缩略图地址 | ||
├─ description | string | 非必须 | 描述 | ||
├─ componentSetUkey | string | 非必须 | 组件所属的组件集唯一标识,当组件集不存在时为空 | ||
├─ lastUpdator | object | 非必须 | 最后一个更新者信息 | ||
├─ id | number | 非必须 | |||
├─ name | string | 非必须 | |||
├─ avatar | string | 非必须 | |||
├─ pageInfo | object | 非必须 | 组件所属页面信息 | ||
├─ pageId | string | 非必须 | 页面id | ||
├─ pageName | string | 非必须 | 页面名称 | ||
├─ layerId | string | 非必须 | 图层id | ||
├─ frameName | string | 非必须 | 容器名称 | ||
├─ backgroundColor | string | 非必须 | 背景颜色 | ||
├─ createdAt | string | 非必须 | 组件创建时间 | ||
├─ updatedAt | string | 非必须 | 组件最后更新时间 | ||
├─ componentSets | object [] | 非必须 | 组件集信息 | item 类型: object | |
├─ ukey | string | 非必须 | 组件集唯一标识 | ||
├─ documentId | number | 非必须 | |||
├─ layerId | string | 非必须 | |||
├─ name | string | 非必须 | |||
├─ cover | string | 非必须 | |||
├─ description | string | 非必须 | |||
├─ lastUpdator | object | 非必须 | |||
├─ id | number | 非必须 | |||
├─ name | string | 非必须 | |||
├─ avatar | string | 非必须 | |||
├─ pageInfo | object | 非必须 | |||
├─ pageId | string | 非必须 | |||
├─ pageName | string | 非必须 | |||
├─ layerId | string | 非必须 | |||
├─ frameName | string | 非必须 | |||
├─ backgroundColor | string | 非必须 | |||
├─ createdAt | string | 非必须 | |||
├─ updatedAt | string | 非必须 | |||
├─ styles | object [] | 非必须 | item 类型: object | ||
├─ ukey | string | 非必须 | |||
├─ documentId | number | 非必须 | |||
├─ name | string | 非必须 | |||
├─ cover | string | 非必须 | |||
├─ description | string | 非必须 | |||
├─ styleType | string | 非必须 | 样式类型 | ||
├─ sortIndex | string | 非必须 | 排序标识 | ||
├─ styleSubType | number | 非必须 | 样式子类型 | ||
├─ lastUpdator | object | 非必须 | |||
├─ id | number | 非必须 | |||
├─ name | string | 非必须 | |||
├─ avatar | string | 非必须 | |||
├─ createdAt | string | 非必须 | |||
├─ updatedAt | string | 非必须 | |||
meta | object | 必须 | |||
├─ time | number | 必须 | |||
├─ trace | string | 必须 | |||
msg | string | 必须 |
获取该团队下所有已经发布的内容
基本信息
Path: /openapi/v1/team/:teamId/libraries
Method: GET
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
X-MG-Authentication | 是 |
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
teamId | 79932816592431 | 团队 id |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | string | 必须 | |||
data | object [] | 必须 | item 类型: object | ||
├─ documentId | number | 非必须 | |||
├─ documentName | string | 非必须 | |||
├─ projectId | number | 非必须 | |||
├─ teamId | number | 非必须 | |||
├─ creator | object | 非必须 | |||
├─ id | number | 非必须 | |||
├─ name | string | 非必须 | |||
├─ avatar | string | 非必须 | |||
├─ createdAt | string | 非必须 | |||
├─ updatedAt | string | 非必须 | |||
├─ publishedScope | string | 非必须 | |||
├─ components | object [] | 非必须 | item 类型: object | ||
├─ ukey | string | 非必须 | |||
├─ documentId | number | 非必须 | |||
├─ layerId | string | 非必须 | |||
├─ name | string | 非必须 | |||
├─ cover | string | 非必须 | |||
├─ description | string | 非必须 | |||
├─ componentSetUkey | string | 非必须 | |||
├─ lastUpdator | object | 非必须 | |||
├─ id | number | 非必须 | |||
├─ name | string | 非必须 | |||
├─ avatar | string | 非必须 | |||
├─ pageInfo | object | 非必须 | |||
├─ pageId | string | 非必须 | |||
├─ pageName | string | 非必须 | |||
├─ layerId | string | 非必须 | |||
├─ frameName | string | 非必须 | |||
├─ backgroundColor | string | 非必须 | |||
├─ createdAt | string | 非必须 | |||
├─ updatedAt | string | 非必须 | |||
├─ componentSets | object [] | 非必须 | item 类型: object | ||
├─ ukey | string | 非必须 | |||
├─ documentId | number | 非必须 | |||
├─ layerId | string | 非必须 | |||
├─ name | string | 非必须 | |||
├─ cover | string | 非必须 | |||
├─ description | string | 非必须 | |||
├─ lastUpdator | object | 非必须 | |||
├─ id | number | 非必须 | |||
├─ name | string | 非必须 | |||
├─ avatar | string | 非必须 | |||
├─ pageInfo | object | 非必须 | |||
├─ pageId | string | 非必须 | |||
├─ pageName | string | 非必须 | |||
├─ layerId | string | 非必须 | |||
├─ frameName | string | 非必须 | |||
├─ backgroundColor | string | 非必须 | |||
├─ createdAt | string | 非必须 | |||
├─ updatedAt | string | 非必须 | |||
├─ styles | object [] | 非必须 | item 类型: object | ||
├─ ukey | string | 非必须 | |||
├─ documentId | number | 非必须 | |||
├─ name | string | 非必须 | |||
├─ cover | string | 非必须 | |||
├─ description | string | 非必须 | |||
├─ styleType | string | 非必须 | |||
├─ sortIndex | string | 非必须 | |||
├─ styleSubType | number | 非必须 | |||
├─ lastUpdator | object | 非必须 | |||
├─ id | number | 非必须 | |||
├─ name | string | 非必须 | |||
├─ avatar | string | 非必须 | |||
├─ createdAt | string | 非必须 | |||
├─ updatedAt | string | 非必须 | |||
meta | object | 必须 | |||
├─ time | number | 必须 | |||
├─ trace | string | 必须 | |||
msg | string | 必须 |
获取文件下已经发布的组件详情
基本信息
Path: /openapi/v1/document/:documentId/components
Method: GET
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
X-MG-Authentication | 是 |
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
documentId |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | string | 必须 | |||
data | object [] | 必须 | item 类型: object | ||
├─ ukey | string | 非必须 | |||
├─ documentId | number | 非必须 | |||
├─ layerId | string | 非必须 | |||
├─ name | string | 非必须 | |||
├─ cover | string | 非必须 | |||
├─ description | string | 非必须 | |||
├─ componentSetUkey | string | 非必须 | |||
├─ lastUpdator | object | 非必须 | |||
├─ id | number | 非必须 | |||
├─ name | string | 非必须 | |||
├─ avatar | string | 非必须 | |||
├─ pageInfo | object | 非必须 | |||
├─ pageId | string | 非必须 | |||
├─ pageName | string | 非必须 | |||
├─ layerId | string | 非必须 | |||
├─ frameName | string | 非必须 | |||
├─ backgroundColor | string | 非必须 | |||
├─ createdAt | string | 非必须 | |||
├─ updatedAt | string | 非必须 | |||
meta | object | 必须 | |||
├─ time | number | 必须 | |||
├─ trace | string | 必须 | |||
msg | string | 必须 |
获取文件下已经发布的组件集详情
基本信息
Path: /openapi/v1/document/:documentId/componentSets
Method: GET
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
X-MG-Authentication | 是 |
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
documentId |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | string | 必须 | |||
data | object [] | 必须 | item 类型: object | ||
├─ ukey | string | 非必须 | |||
├─ documentId | number | 非必须 | |||
├─ layerId | string | 非必须 | |||
├─ name | string | 非必须 | |||
├─ cover | string | 非必须 | |||
├─ description | string | 非必须 | |||
├─ lastUpdator | object | 非必须 | |||
├─ id | number | 非必须 | |||
├─ name | string | 非必须 | |||
├─ avatar | string | 非必须 | |||
├─ pageInfo | object | 非必须 | |||
├─ pageId | string | 非必须 | |||
├─ pageName | string | 非必须 | |||
├─ layerId | string | 非必须 | |||
├─ frameName | string | 非必须 | |||
├─ backgroundColor | string | 非必须 | |||
├─ createdAt | string | 非必须 | |||
├─ updatedAt | string | 非必须 | |||
meta | object | 必须 | |||
├─ time | number | 必须 | |||
├─ trace | string | 必须 | |||
msg | string | 必须 |
获取文件下已经发布的样式详情
基本信息
Path: /openapi/v1/document/:documentId/styles
Method: GET
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
X-MG-Authentication | 是 |
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
documentId |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | string | 必须 | |||
data | object [] | 必须 | item 类型: object | ||
├─ ukey | string | 非必须 | |||
├─ documentId | number | 非必须 | |||
├─ name | string | 非必须 | |||
├─ cover | string | 非必须 | |||
├─ description | string | 非必须 | |||
├─ styleType | string | 非必须 | |||
├─ sortIndex | string | 非必须 | |||
├─ styleSubType | number | 非必须 | |||
├─ lastUpdator | object | 非必须 | |||
├─ id | number | 非必须 | |||
├─ name | string | 非必须 | |||
├─ avatar | string | 非必须 | |||
├─ createdAt | string | 非必须 | |||
├─ updatedAt | string | 非必须 | |||
meta | object | 必须 | |||
├─ time | number | 必须 | |||
├─ trace | string | 必须 | |||
msg | string | 必须 |
获取团队下所有组件详情
基本信息
Path: /openapi/v1/team/:teamId/components
Method: GET
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
X-MG-Authentication | 是 |
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
teamId |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | string | 必须 | |||
data | object [] | 必须 | item 类型: object | ||
├─ ukey | string | 非必须 | |||
├─ documentId | number | 非必须 | |||
├─ layerId | string | 非必须 | |||
├─ name | string | 非必须 | |||
├─ cover | string | 非必须 | |||
├─ description | string | 非必须 | |||
├─ componentSetUkey | string | 非必须 | |||
├─ lastUpdator | object | 非必须 | |||
├─ id | number | 非必须 | |||
├─ name | string | 非必须 | |||
├─ avatar | string | 非必须 | |||
├─ pageInfo | object | 非必须 | |||
├─ pageId | string | 非必须 | |||
├─ pageName | string | 非必须 | |||
├─ layerId | string | 非必须 | |||
├─ frameName | string | 非必须 | |||
├─ backgroundColor | string | 非必须 | |||
├─ createdAt | string | 非必须 | |||
├─ updatedAt | string | 非必须 | |||
meta | object | 必须 | |||
├─ time | number | 必须 | |||
├─ trace | string | 必须 | |||
msg | string | 必须 |
获取团队下已经发布的组件集详情
基本信息
Path: /openapi/v1/team/:teamId/componentSets
Method: GET
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
X-MG-Authentication | 是 |
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
teamId |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | string | 必须 | |||
data | object [] | 必须 | item 类型: object | ||
├─ ukey | string | 非必须 | |||
├─ documentId | number | 非必须 | |||
├─ layerId | string | 非必须 | |||
├─ name | string | 非必须 | |||
├─ cover | string | 非必须 | |||
├─ description | string | 非必须 | |||
├─ lastUpdator | object | 非必须 | |||
├─ id | number | 非必须 | |||
├─ name | string | 非必须 | |||
├─ avatar | string | 非必须 | |||
├─ pageInfo | object | 非必须 | |||
├─ pageId | string | 非必须 | |||
├─ pageName | string | 非必须 | |||
├─ layerId | string | 非必须 | |||
├─ frameName | string | 非必须 | |||
├─ backgroundColor | string | 非必须 | |||
├─ createdAt | string | 非必须 | |||
├─ updatedAt | string | 非必须 | |||
meta | object | 必须 | |||
├─ time | number | 必须 | |||
├─ trace | string | 必须 | |||
msg | string | 必须 |
获取团队下已经发布的样式详情
基本信息
Path: /openapi/v1/team/:teamId/styles
Method: GET
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
X-MG-Authentication | 是 |
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
teamId |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | string | 必须 | |||
data | object [] | 必须 | item 类型: object | ||
├─ ukey | string | 非必须 | |||
├─ documentId | number | 非必须 | |||
├─ name | string | 非必须 | |||
├─ cover | string | 非必须 | |||
├─ description | string | 非必须 | |||
├─ styleType | string | 非必须 | |||
├─ sortIndex | string | 非必须 | |||
├─ styleSubType | number | 非必须 | |||
├─ lastUpdator | object | 非必须 | |||
├─ id | number | 非必须 | |||
├─ name | string | 非必须 | |||
├─ avatar | string | 非必须 | |||
├─ createdAt | string | 非必须 | |||
├─ updatedAt | string | 非必须 | |||
meta | object | 必须 | |||
├─ time | number | 必须 | |||
├─ trace | string | 必须 | |||
msg | string | 必须 |
获取特定组件详情
基本信息
Path: /openapi/v1/component
Method: GET
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
X-MG-Authentication | 是 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
ukey | 是 | 79932944518710%2B79%3A2 | ukey 是组件、组件集、样式的唯一标识,请求时需要对 ukey 进行 url-encode |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | string | 必须 | |||
data | object | 必须 | |||
├─ ukey | string | 非必须 | |||
├─ documentId | number | 非必须 | |||
├─ layerId | string | 非必须 | |||
├─ name | string | 非必须 | |||
├─ cover | string | 非必须 | |||
├─ description | string | 非必须 | |||
├─ componentSetUkey | string | 非必须 | |||
├─ lastUpdator | object | 非必须 | |||
├─ id | number | 非必须 | |||
├─ name | string | 非必须 | |||
├─ avatar | string | 非必须 | |||
├─ pageInfo | object | 非必须 | |||
├─ pageId | string | 非必须 | |||
├─ pageName | string | 非必须 | |||
├─ layerId | string | 非必须 | |||
├─ frameName | string | 非必须 | |||
├─ backgroundColor | string | 非必须 | |||
├─ createdAt | string | 非必须 | |||
├─ updatedAt | string | 非必须 | |||
meta | object | 必须 | |||
├─ time | number | 必须 | |||
├─ trace | string | 必须 | |||
msg | string | 必须 |
获取特定组件集详情
基本信息
Path: /openapi/v1/componentSet
Method: GET
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
X-MG-Authentication | 是 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
ukey | 是 | 79932944518710%2B81%3A8 | 需要对 ukey 进行 url-encode |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | string | 必须 | |||
data | object | 必须 | |||
├─ ukey | string | 非必须 | |||
├─ documentId | number | 非必须 | |||
├─ layerId | string | 非必须 | |||
├─ name | string | 非必须 | |||
├─ cover | string | 非必须 | |||
├─ description | string | 非必须 | |||
├─ lastUpdator | object | 非必须 | |||
├─ id | number | 非必须 | |||
├─ name | string | 非必须 | |||
├─ avatar | string | 非必须 | |||
├─ pageInfo | object | 非必须 | |||
├─ pageId | string | 非必须 | |||
├─ pageName | string | 非必须 | |||
├─ layerId | string | 非必须 | |||
├─ frameName | string | 非必须 | |||
├─ backgroundColor | string | 非必须 | |||
├─ createdAt | string | 非必须 | |||
├─ updatedAt | string | 非必须 | |||
meta | object | 必须 | |||
├─ time | number | 必须 | |||
├─ trace | string | 必须 | |||
msg | string | 必须 |
获取特定样式详情
基本信息
Path: /openapi/v1/style
Method: GET
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
X-MG-Authentication | 是 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
ukey | 是 | 79932944518710%2B79%3A2 | 需要对 ukey 进行 url-encode |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | string | 必须 | |||
data | object | 必须 | |||
├─ ukey | string | 非必须 | |||
├─ documentId | number | 非必须 | |||
├─ name | string | 非必须 | |||
├─ cover | string | 非必须 | |||
├─ description | string | 非必须 | |||
├─ styleType | string | 非必须 | |||
├─ sortIndex | string | 非必须 | |||
├─ styleSubType | number | 非必须 | |||
├─ lastUpdator | object | 非必须 | |||
├─ id | number | 非必须 | |||
├─ name | string | 非必须 | |||
├─ avatar | string | 非必须 | |||
├─ createdAt | string | 非必须 | |||
├─ updatedAt | string | 非必须 | |||
meta | object | 必须 | |||
├─ time | number | 必须 | |||
├─ trace | string | 必须 | |||
msg | string | 必须 |
团队信息
获取企业下团队
基本信息
Path: /openapi/v1/organization/teams
Method: GET
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
X-MG-Authentication | 是 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | string | 必须 | |||
data | object [] | 必须 | item 类型: object | ||
├─ createdAt | string | 非必须 | |||
├─ description | null,string | 非必须 | |||
├─ id | number | 非必须 | |||
├─ logo | string | 非必须 | |||
├─ name | string | 非必须 | |||
├─ ownerId | number | 非必须 | |||
├─ updatedAt | string | 非必须 | |||
meta | object | 必须 | |||
├─ time | number | 必须 | |||
├─ trace | string | 必须 | |||
msg | string | 必须 |
获取用户团队列表
基本信息
Path: /openapi/v1/users/:userId/teams
Method: GET
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
X-MG-Authentication | 是 |
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
userId |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | string | 必须 | |||
data | object [] | 必须 | item 类型: object | ||
├─ createdAt | string | 非必须 | |||
├─ description | null,string | 非必须 | |||
├─ id | number | 非必须 | |||
├─ logo | string | 非必须 | |||
├─ name | string | 非必须 | |||
├─ ownerId | number | 非必须 | |||
├─ updatedAt | string | 非必须 | |||
meta | object | 必须 | |||
├─ time | number | 必须 | |||
├─ trace | string | 必须 | |||
msg | string | 必须 |
获取团队下项目
基本信息
Path: /openapi/v1/team/:teamId/projects
Method: GET
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
X-MG-Authentication | 是 |
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
teamId |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | string | 必须 | |||
data | object [] | 必须 | item 类型: object | ||
├─ createdAt | string | 非必须 | |||
├─ id | number | 非必须 | |||
├─ name | string | 非必须 | |||
├─ updatedAt | string | 非必须 | |||
meta | object | 必须 | |||
├─ time | number | 必须 | |||
├─ trace | string | 必须 | |||
msg | string | 必须 |
获取团队下文件
基本信息
Path: /openapi/v1/team/:teamId/documents
Method: GET
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
X-MG-Authentication | 是 |
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
teamId |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | string | 必须 | |||
data | object [] | 必须 | item 类型: object | ||
├─ createdAt | string | 非必须 | |||
├─ creatorId | number | 非必须 | |||
├─ id | number | 非必须 | |||
├─ name | string | 非必须 | |||
├─ ownerId | number | 非必须 | |||
├─ type | number | 非必须 | 文件类型 | ||
├─ updatedAt | string | 非必须 | |||
meta | object | 必须 | |||
├─ time | number | 必须 | |||
├─ trace | string | 必须 | |||
msg | string | 必须 |
获取项目下文件
基本信息
Path: /openapi/v1/project/:projectId/documents
Method: GET
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
X-MG-Authentication | 是 |
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
projectId |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | string | 必须 | |||
data | object [] | 必须 | item 类型: object | ||
├─ createdAt | string | 非必须 | |||
├─ creatorId | number | 非必须 | |||
├─ id | number | 非必须 | |||
├─ name | string | 非必须 | |||
├─ ownerId | number | 非必须 | |||
├─ type | number | 非必须 | |||
├─ updatedAt | string | 非必须 | |||
meta | object | 必须 | |||
├─ time | number | 必须 | |||
├─ trace | string | 必须 | |||
msg | string | 必须 |
获取团队下已经发布的文件
基本信息
Path: /openapi/v1/team/:teamId/lib/documents
Method: GET
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
X-MG-Authentication | 是 |
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
teamId |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | string | 必须 | |||
data | object [] | 必须 | item 类型: object | ||
├─ createdAt | string | 非必须 | |||
├─ creatorId | number | 非必须 | |||
├─ id | number | 非必须 | |||
├─ libraryId | string | 非必须 | |||
├─ name | string | 非必须 | |||
├─ ownerId | number | 非必须 | |||
├─ type | number | 非必须 | |||
├─ updatedAt | string | 非必须 | |||
meta | object | 必须 | |||
├─ time | number | 必须 | |||
├─ trace | string | 必须 | |||
msg | string | 必须 |
获取项目下已经发布的文件
基本信息
Path: /openapi/v1/project/:projectId/lib/documents
Method: GET
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
X-MG-Authentication | 是 |
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
projectId |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | string | 必须 | |||
data | object [] | 必须 | item 类型: object | ||
├─ createdAt | string | 非必须 | |||
├─ creatorId | number | 非必须 | |||
├─ id | number | 非必须 | |||
├─ libraryId | string | 非必须 | |||
├─ name | string | 非必须 | |||
├─ ownerId | number | 非必须 | |||
├─ type | number | 非必须 | |||
├─ updatedAt | string | 非必须 | |||
meta | object | 必须 | |||
├─ time | number | 必须 | |||
├─ trace | string | 必须 | |||
msg | string | 必须 |
其他
根据 userCode 获取用户 id
基本信息
Path: /openapi/v1/user
Method: GET
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
X-MG-Authentication | 是 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
userCode | 是 | xxxxxxx |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | string | 必须 | |||
data | object | 必须 | |||
├─ userId | number | 必须 | MG用户id | ||
meta | object | 必须 | |||
├─ trace | string | 必须 | |||
├─ time | string | 必须 |