进阶 docs.pangolin.net 2026-11-21 15:06:37 · 2 阅读

第12章 Integration API 集成接口指南

Integration API(集成 API)

了解如何使用 Pangolin 的 REST API,在细粒度权限控制下实现操作的自动化和脚本化。

Pangolin 仍在快速开发中。REST API 的路由和行为在不同版本之间可能存在破坏性变更,我们会尽力对重大变更做好文档说明。

这套 API 基于 REST,支持网页界面上可用的多数操作。认证采用 Bearer token,你可以为不同使用场景创建多个拥有特定权限的 API key。

对于自托管版本,需要先启用集成 API 才能使用,具体方法请参阅相关文档。

认证

所有 API 请求都需要认证,在 Authorization 请求头中携带 Bearer token:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.example.com/v1/

API Key 类型

Pangolin 支持两种权限级别不同的 API key:

组织级 API Key(Organization API Keys)

由组织管理员创建,权限范围仅限于该组织内的操作。

根级 API Key(Root API Keys)

拥有一些额外权限,可以跨组织执行操作,仅在完全自托管的 Pangolin 版本中可用:

根级 API key 权限较高,使用时需谨慎。仅在确实需要服务器级全局访问时才创建。

创建 API Key

  1. 进入管理面板:打开你的管理面板:
    • 组织级 key:Organization → API Keys
    • 根级 key:Server Admin → API Keys(仅限自托管版本)
  2. 生成新 key:点击 "Create API Key",并为该 key 起一个便于识别的名字。
  3. 配置权限:在权限选择器中勾选该 API key 所需的具体权限。

(图:API key 权限选择器,展示可选操作)

  1. 复制并妥善保存 key:生成后立即复制 API key,之后将不再显示。
请安全保管 API key,切勿提交到版本控制系统。建议使用环境变量或安全的密钥管理工具。

API 文档

常见流程(sites、resources、targets、角色和用户分配)的简要示例请参阅 Common API Routes。

符合 OpenAPI 规范的文档位于 https://api.pangolin.net/v1/openapi.json 和 https://api.pangolin.net/v1/openapi.yaml。

完整的 Swagger 文档见:https://api.pangolin.net/v1/docs。

(图:Swagger UI,展示 API 端点并支持交互式测试)

自托管的 Pangolin 可通过 https://api.your-domain.com/v1/docs 访问文档。

这个页面有帮助吗?

评论 (0)