Waafir
本页面为机器翻译,尚待人工审核,可能存在错误。

平台 API(/v1)

平台 API 是 Waafir 带版本号的 HTTP 接口。您可以用它从自己的系统中读取和管理您的组织。它涵盖您的团队(邀请成员、更改角色、移除成员)、对数据室、文件夹和文件的访问授权、问答、数据室聊天与智能体、活动和按交易对方划分的参与度,以及投资组合监控。

它与 Waafir 的 MCP 服务器是两个独立的接口,后者以工具形式将同一平台开放给 AI 客户端。两者使用相同的个人访问令牌进行身份验证。

基础 URL

所有端点都位于:

https://app.waafir.io/api/v1

端点参考按完整路径列出了每个端点,例如 GET /api/v1/team。

您的第一次调用

  1. 签发令牌。在 Waafir 中打开附加功能 → 配置,签发一个个人访问令牌。开始时使用 read 令牌即可。复制令牌值,它以 waafir_pat_ 开头。该值只显示一次。
  2. 查询您的身份。GET /api/v1/session 会返回该令牌所代表的身份和组织。在基于某个令牌进行开发之前,可以先用它检查令牌是否有效:
curl -s https://app.waafir.io/api/v1/session \
  -H "Authorization: Bearer $WAAFIR_TOKEN"
{
  "orgId": "…",
  "userId": "…",
  "email": "you@example.com",
  "orgRole": "admin",
  "authMethod": "pat",
  "principalType": "user"
}

401 表示令牌缺失、输入错误、已过期或已被撤销。其他拒绝通常带有机器可读的 code,其含义在错误码页面中说明。有些拒绝不带 code,因此请始终以 HTTP 状态码作为后备判断依据。

参考文档是如何生成的

端点和错误码页面在本站每次发布时,都会根据平台自身的路由树自动生成,而不是手工编写。生产版本会从与应用相同的提交构建这些页面,因此它们列出的正是该版本所提供的路由,以及每个端点所需的角色门槛、令牌权限范围和所接受的查询参数。其中的错误列表只是已知的最小集合,并不详尽:端点可能返回生成器无法识别的错误码,因此请按 HTTP 状态码处理未列出的错误。

版本管理

/v1 在其版本内只做增量变更。Waafir 可能会新增响应字段和可选的请求参数。在 /v1 内,它不会删除现有字段或更改其类型,也不会删除端点。破坏性变更会以新的版本前缀发布。请编写能够忽略无法识别字段的客户端。

下一步