跳转到正文

获取图形验证码 ​

获取指定操作的验证码图片。验证码与当前 PHPSID 会话绑定,请把会话保存到后续登录、注册或短信请求。

GET /app/auth/captcha

调用方: 随附宿主应用 · 认证: 无需登录,流程中保留 PHPSID

登录前也可调用。涉及验证码或短信时,要在整个流程中保留同一个 PHPSID 会话。

请求参数 ​

Query ​

参数类型必填说明
scenestring是login 登录、register 普通注册、register_sms 发送注册短信。

请求示例 ​

bash
curl -G 'https://example.com/app/auth/captcha' \
  -b cookies.txt -c cookies.txt \
  --data-urlencode 'scene=login' \
  --output captcha.jpg

使用说明 ​

  • 成功返回 JPEG 图片,没有 code/msg/data 包装。若当前场景未开启验证码,则返回 code=3003 的 JSON 错误。
  • 验证码为 4 个英文字母,不区分大小写;校验时会消耗该验证码,失败后重新获取。register_sms 场景的图形验证码有效期为 300 秒。

返回参数 ​

此接口的成功响应是文件、图片或响应头,请按 HTTP 状态和响应头处理。

字段类型说明
Content-Typeheader string成功时为 image/jpeg,正文是验证码图片。
PHPSIDheader string本次验证码所属会话 ID,后续操作要使用同一会话。
Cache-Controlheader stringno-store, no-cache, must-revalidate,不缓存验证码。
Pragmaheader stringno-cache。
Access-Control-Expose-Headersheader stringPHPSID,允许跨域客户端读取此响应头。

错误处理 ​

验证码场景未开启或请求参数不正确时,可能返回 JSON 错误。先检查状态码及 Content-Type,再决定按图片还是错误结果处理。

返回随附宿主账号接口列表 · HTTP 请求约定