介绍
# Confluence Cloud REST API v2
使用此技能可直接调用 **Confluence Cloud REST API v2** 端点。支持 **所有 v2 组**（页面、空间、文件夹、白板、数据库、嵌入、评论、标签、属性、任务等）。
## 快速开始
1) 配置凭据（任选其一）： - **Basic**：邮箱 + API 令牌 - **OAuth**：访问令牌
2) 使用 `scripts/` 目录中的脚本调用端点。
## 配置
设置这些环境变量（推荐）或将其存储在本地配置文件中：
``` CONFLUENCE_BASE_URL=https://pangin.atlassian.net/wiki CONFLUENCE_AUTH_METHOD=basic # basic | oauth [email protected] CONFLUENCE_API_TOKEN=YOUR_TOKEN # or for OAuth # CONFLUENCE_OAUTH_TOKEN=YOUR_OAUTH_ACCESS_TOKEN
# Optional admin key header (Premium/Enterprise only) # CONFLUENCE_ADMIN_KEY=true ```
**Base URL** 始终为 `https://<site>.atlassian.net/wiki`。
## 核心辅助工具
- `scripts/client.js` — HTTP 客户端封装、身份验证标头、分页 - `scripts/*` — 端点组（页面、空间、文件夹等）
## 示例
```bash # list everything node scripts/spaces.js list --all node scripts/pages.js list --all node scripts/labels.js list --all
# get single items node scripts/pages.js get 89522178 node scripts/folders.js direct-children 87457793
# ad-hoc call node scripts/call.js GET /folders/87457793/direct-children ```
## 从 confluence-cli 迁移
如果存在 `~/.confluence-cli/config.json`，请进行映射： - `domain` → `CONFLUENCE_BASE_URL` (`https://{domain}/wiki`) - `email` → `CONFLUENCE_EMAIL` - `token` → `CONFLUENCE_API_TOKEN`
## 参考资料
- OpenAPI 规范：`refs/openapi-v2.v3.json` - 端点列表：`refs/endpoints.md` - 权限范围：`refs/scopes.md` - 测试：`refs/tests.md` - 使用技巧：`refs/usage.md`