API 参考
浏览公开内容、个人接口、机器人事件、OAuth、资源查询与 Webhook 接口。
每个接口都有独立页面,可直接复制地址分享。接口与指南共用左侧目录和站点搜索;搜索接口名称、路径或参数即可定位。
| 接口组 | 适用场景 | 契约文件 |
|---|---|---|
| 公开内容 | 无需登录的内容与组织查询 | public.json |
| 个人 API | 使用 PAT 或获授权的 OAuth access 访问自己的内容、资料与组织 | personal.json |
| 开放平台 | 授权、token、撤销与 userinfo | oauth.json |
| Webhook | 网站会话管理和资源发布事件 | webhooks.json |
| 机器人事件 | 机器人令牌读取触发事件并幂等回复 | bots.json |
| 精简资源查询 | 资源列表、详情与更新构建 | public-v1.json |
接口页面提供参数、响应与 Fetch/curl 示例。需要验证请求时,在页面中手动打开请求工具并填写自己的凭据;文档站不保存凭据,也不代理请求。
Webhook 管理页提供网站同源 Fetch 和 curl Cookie 示例;由于管理会话只属于网站,该组不在跨域文档站直接发送请求。写操作先在网站完成二次验证,并提供匹配的 CSRF。
v1 的公开查询、个人 API、OAuth 和机器人事件接口分别使用 /v1/site、/v1/personal、/v1/oauth2、/v1/bots;另有三条精简资源只读路径 /v1/resources。公开组织查询匿名可用;个人资料和组织操作逐接口要求相应 scope。个人 API 不使用网站 Cookie;机器人事件只接受机器人 PAT。OAuth 授权端点的可选会话行为以其接口页为准。接入步骤见公共 API v1 指南与机器人接入指南。
Webhook 管理继续使用网站同源 /api/webhooks,写操作需要 Cookie、CSRF 和二次验证;跨域文档站不读取 HttpOnly Cookie。