开发者设置

阅读需 1 分钟

个人密钥、应用客户端,以及接入智能体或 CLI:Sofia API 页面上的各项操作,以及这几种方式分别适合在什么情况下选用。

这个栏目是所有程序化功能的入口。参考文档在 API、Agents 和「将 Sofia 添加到你的应用」这几个标签页中;本页介绍界面上的各项操作。打开设置,进入「Sofia API」栏目。

本页内容访问应用客户端用密钥还是 OAuth 客户端?延伸阅读

访问

该页面有两个标签页:「个人访问」和「应用客户端」。

你的个人密钥

  • 创建密钥。「新建密钥」:可以为它命名,设置有效期(7 天、30 天、90 天、1 年或永不过期)以及权限。默认全部勾选;只保留你的工具需要的权限。
  • 立即复制。它只显示一次,Sofia 只保留它的指纹。
  • 使用它。把它放在每次调用的 Authorization: Bearer 请求头中。一个密钥对你所有的门店生效,权限与你相同。

连接 AI 助手

对于 Claude、ChatGPT、Cursor、Gemini CLI 或 Claude Code,使用已连接应用中的连接器通常更简单:它不需要任何密钥。参见 AI 连接器。

CLI 与智能体

「复制智能体说明」会给出一段文字,粘贴到你的智能体中,它就会使用 API。sofia 命令以 sofia-post 为名发布在 npm 上,它封装了 API,可从终端、脚本或定时任务中发布;安装方法见「Agents」标签页。

应用客户端

应用客户端用来构建让其他 Sofia 用户授权的东西,而不是以你的身份操作的东西。

  • 创建客户端。「新建客户端」:填写名称、不小于 180 × 180 像素的徽标、隐私政策的地址、一到五个 HTTPS 重定向 URL,以及应用可以请求的权限。名称和徽标会在授权过程中展示给用户。
  • 复制凭据。你会得到 Client ID 和 Client Secret。公开客户端适用于代码公开的应用,没有密钥,使用 PKCE 进行身份验证;这个选择无法更改。
  • 实现授权流程。参见「将 Sofia 添加到你的应用」标签页。

用密钥还是 OAuth 客户端?

标准个人密钥应用客户端
以谁的身份操作你授权它的用户
适用于你自己的脚本和自动化其他 Sofia 用户会使用的产品
设置方式复制密钥声明客户端并实现授权流程
撤销方式「撤销」密钥用户在「已连接的应用」中撤销访问,或者你删除客户端

如果你自动化的是自己的发布,请使用密钥。只有涉及他人账号时,才需要构建客户端。

延伸阅读

  • API:访问端点、请求负载和各平台的设置,见 API 标签页。
  • CLI:在终端中发布,见 Agents 标签页。
  • AI 连接器:接入 Claude、Cursor 或 ChatGPT,参见 AI 连接器。