外观
读取宿主应用配置
在登录页或注册页读取应用名称、WebSocket 地址和验证码等开关。无需登录。
GET /app/auth/config
调用方: 随附宿主应用 · 认证: 无需登录,流程中保留 PHPSID
登录前也可调用。涉及验证码或短信时,要在整个流程中保留同一个 PHPSID 会话。
请求参数
无业务参数。
请求示例
bash
curl 'https://example.com/app/auth/config' \
-b cookies.txt -c cookies.txt返回参数
成功响应的最外层字段如下。下面所有业务字段都位于 data 中。
| 字段 | 类型 | 说明 |
|---|---|---|
code | integer | 0 表示成功;非 0 时查看 msg,不把 data 当成功结果使用。 |
msg | string | 成功通常为 ok,失败时为错误说明。 |
data | object | 本次请求的业务结果,字段见下表。 |
data 字段
| 字段 | 类型 | 说明 |
|---|---|---|
app_name | string | 后台配置的应用名称。 |
websocket_url | string | 客户端应连接的 WebSocket 地址;未配置时可能为空字符串。 |
register_enabled | boolean | 是否开放注册。 |
register_captcha | boolean | 普通账号注册是否要求图形验证码。 |
login_captcha | boolean | 登录是否要求图形验证码。 |
register_mobile_verification | boolean | 注册是否启用手机短信验证;启用后注册流程使用手机与短信验证码。 |
返回示例
示例展示字段结构;ID、时间和资料仅作说明,请使用实际回包。
json
{
"code": 0,
"msg": "ok",
"data": {
"app_name": "PopoIM",
"websocket_url": "wss://example.com/ws",
"register_enabled": true,
"register_captcha": true,
"login_captcha": false,
"register_mobile_verification": false
}
}错误处理
先检查 HTTP 状态,再检查 code。业务失败可能仍为 HTTP 200;非 0 的 code 都不能当成功。完整错误码见请求约定。
