创建接口 Token
获取您的 Api-Key
您可以前往docmee开放平台 注册账号,并获取您的 Api-Key。
获取方式
- 登录 docmee开放平台
- 点击右上角 “进入工作台” 按钮
- 在“我的工作台”页面,选择 “API KEY” 标签页
- 在“API KEY”页面,点击“复制”
接口信息
- 方法:POST
- 路径:
- 鉴权:请求头传
Api-Key
接口作用
创建后续 API 调用使用的临时 token。该 Token 支持按 uid 做数据隔离,也支持通过 limit 限制最多可生成的 PPT 次数。
请求示例
curl --request POST \ --url https://open.docmee.cn/api/user/createApiToken \ --header "Content-Type: application/json" \ --header "Api-Key: YOUR_API_KEY" \ --data '{ "uid": "third-party-user-id", "limit": 10, "timeOfHours": 2 }'
请求参数
{ "uid": "third-party-user-id", "limit": 10, "timeOfHours": 2 }
uid:第三方用户 ID,建议传入,便于用户隔离limit:允许生成 PPT 的次数;0表示不能生成timeOfHours:有效期小时数,默认 2,最大 48
请求字段说明
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
uid | string | 否 | third-party-user-id | 第三方用户标识,用于隔离数据。 |
limit | number | 否 | 10 | 允许调用或生成的次数上限。 |
timeOfHours | number | 否 | 2 | 字段用途请结合接口场景传入。 |
响应示例
{ "data": { "token": "sk_xxx", "expireTime": 7200 }, "code": 0, "message": "操作成功" }
响应字段说明
| 字段名 | 类型 | 示例 | 说明 |
|---|---|---|---|
data | object | {"token":"sk_xxx","expireTime":7200} | 业务数据对象。 |
data.token | string | sk_xxx | 字段用途请结合接口场景传入。 |
data.expireTime | number | 7200 | 字段用途请结合接口场景传入。 |
code | number | 0 | 通用响应状态码,0 表示成功。 |
message | string | 操作成功 | 服务端返回的结果说明。 |
多语言示例
const response = await fetch('https://open.docmee.cn/api/user/createApiToken', { method: 'POST', headers: { 'Content-Type': 'application/json', 'Api-Key': 'YOUR_API_KEY' }, body: JSON.stringify({ uid: 'demo-user', limit: 10, timeOfHours: 2 }) }) console.log(await response.json())
使用说明
- 该接口应只在服务端调用
- 同一个
uid再次创建 Token 时,旧 Token 会立即过期失效 - UI 集成场景建议始终设置
limit,降低泄露风险 - 封面图片资源访问,需要在 url 上拼接 ?token=xxx
Last updated on