外观
接口参考
本节由 OpenAPI spec 直接生成,每个接口一页,内置 Try it 演练面板。接口契约以 OpenAPI 规范为准,文档与 SDK(TS / Java SDK)均由它生成,三者始终保持一致。
关于 Try it 的目标地址:Try it 面板默认指向的是一个示例地址(
https://atkonbase.example.com/api)。Try it 面板顶部可切换/自定义目标 server——把它指向你自己的 atkonbase 部署即可发起真实请求(需要该部署对文档站放行 CORS)。在正式的 ATKONBASE 门户中,Try it 已默认指向对应环境的 API 地址,通常无需手动切换。
两套 API
| API | 前缀 | 受众 | 认证 |
|---|---|---|---|
| V1 集成 API | /v1/* | 集成方业务后端(client credentials) | Authorization: Bearer <accessToken> |
| 公开分享 API | /public/s/* | 分享链接的匿名/受控访问 | 分享 token(路径参数) |
如何使用本节
- 左侧按业务域(
V1/Document、V1/Acl、V1/Metadata…)展开找到目标接口。 - 页面展示路径、参数、请求体 / 响应 schema 与示例。
- 在 Try it 面板的「请求头」分组填入
Authorization(完整值含Bearer前缀),按需填X-Atk-User-Token等注入类头与其余参数,选择目标 server,点击发送。
新接入请先读 入门篇 跑通最小闭环,再回到本节查具体接口。