开放 API

介绍

CMS Open API 提供公开的数据接口供任意前端应用对接使用

使用示例

Web

const axios = require("axios");

const env = "<环境ID>";
const region = "<地域，如 ap-shanghai>";
const kitId = "<CMS的实例ID>";
const projectId = "<CMS项目唯一ID>";
const collectionId = "<CMS集合唯一ID>";

const data = await axios.get(
  `https://${env}.${region}.kits.tcloudbase.com/cms/${kitId}/v1/open-api/projects/${projectId}/collections/${collectionId}/contents?limit=10&offset=0`
);

Node.js

const axios = require("axios");

const env = "<环境 ID>";
const region = "<地域，如 ap-shanghai>";
const kitId = "<CMS 的实例 ID>";
const projectId = "<CMS 项目唯一 ID>";
const collectionId = "<CMS 集合唯一 ID>";

const data = await axios.get(
  `https://${env}.${region}.kits.tcloudbase.com/cms/${kitId}/v1/open-api/projects/${projectId}/collections/${collectionId}/contents?limit=10&offset=0`
);

Shell

env="<环境 ID>" && \
region="<地域，如 ap-shanghai>" && \
kitId="<CMS 的实例 ID>" && \
projectId="<CMS 项目唯一 ID>" && \
collectionId="<CMS 集合唯一 ID>" && \
curl "https://$env.$region.kits.tcloudbase.com/cms/$kitId/v1/open-api/projects/$projectId/collections/$collectionId/contents?limit=10&offset=0"

API 列表

查询集合内容

请求方法：GET

请求地址：https://${env}.${region}.kits.tcloudbase.com/cms/${kitId}/v1/open-api/projects/${项目ID}/collections/${集合ID}/contents?limit=10&offset=0

参数

• Query parameters

名称	类型	是否必填	默认值	描述
offset	number	否	0	偏移量，从 0 开始
limit	number	否	30	每页数据数量，最大 100

响应

{
    "code": "NORMAL",
    "result":{
        "data": IContent[],
        "total": number
      },
    "requestId": ""
}

查询单条记录

请求方法：GET

请求地址：https://${env}.${region}.kits.tcloudbase.com/cms/${kitId}/v1/open-api/projects/${项目ID}/collections/${集合ID}/contents/${内容ID}

参数

无

响应

{
    "code": "NORMAL",
    "result":IContent,
    "requestId": ""
}