API 参考 / auth

用 6 位验证码校验邮箱

POST /api/v1/auth/verify-email-code · verifyEmailCode

注册后邮件里下发 6 位数字验证码，用户在验证屏输入完成邮箱验证。 code 不对 / 已过期 / 尝试次数超限一律返回统一的 400，不暴露具体原因（防枚举与防爆破）。 与 /auth/verify-email 的一次性链接互为并存路径（链接为休眠回退，验证码为默认交互）。公开端点。 可携带 invitationToken 走邀请落地注册流（设计稿 09 屏 · 未注册分支）：仅当本次请求真正 消费了验证码（非已验证幂等旁路）时才签发会话（Set-Cookie gf_session），并自动接受该邀请 （校验邀请归属该邮箱且 pending / 未过期 / 未撤销）；自动接受失败不影响验证结果， 响应以 invitation.accepted=false 表达，由前端回落邀请落地页。

公开端点，无需鉴权。

请求体

email（必填）
string
code（必填）
string —— 6 位数字验证码
invitationToken
string —— 邀请落地注册流：验证通过后自动接受该邀请并签发会话

响应字段 · 200

emailVerified（必填）
boolean
sessionEstablished
boolean —— 仅邀请落地验证码流：本次验证已签发会话（Set-Cookie gf_session）
invitation
VerifyInvitationOutcome —— 邀请落地验证码流的自动接受结果。accepted=false 时前端回落邀请落地页处理异常态。
invitation.accepted（必填）
boolean
invitation.projectId
string
invitation.subdomainPrefix
string
invitation.roleId
string

错误

请求示例（curl）

curl -X POST "https://workflow.games/api/v1/auth/verify-email-code" \
  -H "content-type: application/json" \
  --data '{"email":"[email protected]","code":"示例文本","invitationToken":"示例文本"}'

响应示例

HTTP/1.1 200
{
  "emailVerified": true,
  "sessionEstablished": true,
  "invitation": {
    "accepted": true,
    "projectId": "018f3c2e-0000-7000-8000-000000000000",
    "subdomainPrefix": "示例文本"
  }
}

合同真值：OpenAPI 3.1（0.1.0）。

相关：Agent 接入指南 · 使用指南 · API 参考索引

Workflow 正在加载…