开发者文档 · 开放接口

认证与密钥

开放接口用个人 API 密钥认证:在 H5 新建,按需勾选权限,放在 X-Api-Key 请求头里。

新建密钥

  1. 打开 H5,进入「我的 → API 密钥」;
  2. 新建一把密钥,填写名称(方便以后辨认是哪台设备在用),勾选需要的权限,选择有效期(30 天、90 天、1 年或不过期,默认 90 天);
  3. 保存后会显示完整密钥,只显示这一次,请立即复制保存。平台只保存密钥的摘要,之后无法再查看原文。

密钥以 yqpj_pat_ 开头。新建时不勾选任何权限,默认带「查看我的项目」和「接入值守」两项。

在命令行中使用时,执行 yqpj-agent login 按提示填入密钥即可,之后的命令会自动带上它。

请求头

每个请求都在请求头里带上密钥:

X-Api-Key: yqpj_pat_<你的密钥>

密钥缺失、写错、已过期或已吊销时,接口返回错误码 1024017030。

权限与接口

每个接口要求一项权限,密钥没有该权限时返回错误码 1024017031,提示缺少哪一项。

权限(代码)说明可调用的接口
查看我的项目
PROJECT_READ
查看你能处理反馈的项目及资料GET /projects
GET /changelog
GET /models/project-context
接入值守
AGENT_MANAGE
注册处理端、领取项目令牌、登记上线POST /agent/attach
POST /releases/publish
查看反馈
FEEDBACK_READ
查看项目的反馈单GET /feedback
新建项目
PROJECT_WRITE
新建项目(含合作方、开发费用、所处阶段)及修改项目POST /projects/create
POST /projects/update
POST /projects/fees/save
POST /models/draft
本机开发调度
DEV_DISPATCH
本机开发调度领取新项目、建分支开会话/dev-dispatch/*
本机值守调度
FEEDBACK_DISPATCH
按需拉起值守会话、上报会话运行情况、切换处理端运行方式(只对自己负责的处理端)/feedback-dispatch/*
社区内容审核
COMMUNITY_REVIEW
本机 AI 审核会话读取待审内容并提交决定(还需在平台登记为审核员)/community/review/*

表中路径都相对于 https://api.yqpj.com/app-api/project/open-api。GET /me 不要求权限,任何有效密钥都能调用。后三项供 yqpj-agent 的本机调度功能使用,一般不需要自己调用。

吊销

在「我的 → API 密钥」里吊销不再使用的密钥,吊销后立即失效。设备丢失、密钥可能泄露时,请第一时间吊销并重新新建。

安全建议

  • 按用途只勾需要的权限,一台设备一把密钥,名称写清设备;
  • 不要把密钥写进代码仓库、截图、日志或群聊;
  • 密钥的最近使用时间和 IP 会被记录,发现异常及时吊销。
密钥代表你本人的身份,能做的事与你在平台上的权限一致:只能操作你创建的项目或你已接受邀请的开发者项目。