API 密钥与身份验证
API 密钥让您自己的代码、Posty5 SDK、n8n 和 AI 助手能够使用您的 Posty5 账户。本页说明密钥的工作方式,其他开发者页面会链接到这里,而不再重复说明。
获取开发者账户
Section titled “获取开发者账户”API 密钥是开发者账户的功能。升级免费且立即生效,不会改变您的套餐或积分。
-
在 Posty5 控制台中,打开“账户设置”,然后选择“API 密钥”。
-
选择“升级为开发者”。页面会重新加载,并显示您的 API 密钥以及连接 Posty5 的方式。
-
在“API 密钥”中,选择“创建 API 密钥”。
-
为密钥起一个能说明用途的名称,例如“网站联系表单”。该名称仅供您自己查看。
-
选择其记录范围(见下文说明),然后选择“创建”。新密钥会显示出来,并附有复制按钮。
密钥并非只显示一次。列表会以遮盖形式显示每个密钥,需要时点击其复制按钮即可再次复制完整密钥。在列表中通过密钥的操作菜单可以重命名密钥或更改其记录范围。
在每个请求中发送密钥
Section titled “在每个请求中发送密钥”在发往 Posty5 API 的每个请求中,通过以下请求头发送密钥——
- API 的地址是
要检查密钥,请调用描述该密钥的路由。它会返回密钥、其所有者、套餐以及账户可用的积分。已撤销或未知的密钥会收到 401。
curl https://api.posty5.com/api/api-key/current \ -H "X-API-Key: YOUR_API_KEY"SDK 和 n8n 节点使用同一个密钥。
| 客户端 | 密钥的填写位置 | 了解更多 |
|---|---|---|
| JavaScript / TypeScript | new HttpClient({ apiKey: "YOUR_API_KEY" }) | npm-sdk |
| .NET | new Posty5Options { ApiKey = "YOUR_API_KEY" } | dotnet-sdk |
| n8n | Posty5 API 凭据中的 API Key 字段 | n8n-nodes |
选择密钥可以查看的内容
Section titled “选择密钥可以查看的内容”每个密钥都有一个记录范围,它决定该密钥可以列出和编辑您的哪些记录。
| 记录范围 | 密钥可列出和编辑的内容 |
|---|---|
| 仅显示使用此密钥创建的记录 | 仅限此密钥创建的记录。您在控制台中或用其他密钥创建的记录都不在它的访问范围内,因此两个集成永远不会互相干扰。 |
| 我的整个账户 | 您账户中的所有记录,无论在哪里创建。AI 助手通常需要此选项,因为您会向它询问您自己创建的内容。 |
新密钥默认使用“仅显示使用此密钥创建的记录”,在此设置推出之前创建的所有密钥也是如此。如需更改,请打开密钥的操作菜单并选择“更改记录范围”。密钥的 MCP 链接使用该密钥的记录范围。
最近使用与撤销密钥
Section titled “最近使用与撤销密钥”“最近使用”列显示密钥最后一次发出请求的时间。该列最多每隔几分钟更新一次,因此持续使用中的密钥可能显示得比实际晚几分钟。
要撤销密钥,请在列表中打开其操作菜单,选择“撤销”并确认。
- 密钥会立即失效。所有使用它的应用、脚本和集成在下一次请求时都会收到 401。
- 其 AI 助手(MCP)链接也会在同一时刻停止工作。
- 撤销后无法恢复。如果您再次需要,请创建新密钥。
- 密钥已完成的操作会保留。它创建的记录仍保留在您的账户中,它排期的帖子仍会按时发布,因为排期发布不使用该密钥。
使用 API 密钥发起的调用,费用与在控制台中执行同一操作完全相同,所需积分从拥有该密钥的账户中扣除。每项操作的价格列于: 功能积分
确保密钥安全
Section titled “确保密钥安全”- 请将密钥保存在服务器上。切勿把密钥放在网页、移动应用或公开代码仓库中——任何读到它的人都能以您的身份操作。
- 密钥无法管理密钥。创建、列出、重命名和撤销密钥只能在您登录 Posty5 时进行,因此泄露的密钥无法读取您的其他密钥,也无法创建新密钥。
- 要轮换密钥,请先创建新密钥,将您的集成切换到新密钥,确认新密钥的“最近使用”日期有更新,然后撤销旧密钥。
- 如果密钥泄露,请立即将其撤销并创建新密钥。