POST/api/v1/realtime/dev-tickets
local/dev且非prod配置 · 独立密钥JSON 响应接入指南 ↗

申请开发联调票据

请求参数

该接口只在启用长连接的 local/dev 运行配置下注册;任何包含 prod 的配置组合均不注册。这里表示配置条件,不代表另有测试服。只有开发探针权限,不能成为真实用户或管理员。

请求头 必填 说明
X-Dev-Access-Key 是 运维提供的独立测试密钥,不在公开文档中分发
公共客户端元数据 是 全部遵循公共请求头,设备 UUID 使用合成或测试安装标识
Accept-Language 建议 当前 App 语言 zh-CN/en/ja/ko,未传或未支持则英文

无正文。密钥、票据和连接通过 SSH 隧道或已验证的 HTTPS/WSS 传输;当前公网明文地址只用于不含凭据的握手检查。

请求示例

开发者通过受控渠道取得测试密钥,并使用已建立的安全隧道访问本机 18080。下例所有身份均为合成测试数据;测试密钥从调用进程环境提供,不写进源文件:

curl -X POST 'http://127.0.0.1:18080/api/v1/realtime/dev-tickets' \
  -H "X-Dev-Access-Key: $BUDYOO_DEV_ACCESS_KEY" \
  -H 'Accept-Language: zh-CN' \
  -H 'X-Client-Type: app' -H 'X-Platform: android' \
  -H 'X-App-Version: 1.0.0' -H 'X-App-Build: 1' -H 'X-Channel: dev' \
  -H 'X-Device-Id: 4d4ae3ea-6a4a-4f34-a292-8e94551851d7' \
  -H "X-Request-Id: $(uuidgen)" -H "X-Request-Timestamp: $(date +%s)000"

示例响应中的票据也需保密;公开网页不放测试密钥。正式 App 使用正式身份票据入口。

成功响应

返回标准 ApiResponse,data 与正式票据结构相同,且禁止缓存。票据绑定服务端生成的 dev-probe:<安装UUID> 身份;认证完成后 ready.data.developmentProbe 为 true。

此连接可发送 probe 验证 Redis 通道,结果为 probe.result、data.via: redis。不接受任意目标用户或聊天消息。

失败响应

缺少或错误测试密钥为 401;客户端头错误为 400;同探针身份签发频率超限为 429;Redis 不可用为 503。重放已经消费的票据时,WebSocket 返回 INVALID_TICKET 后以 1008 关闭。

接入说明

设备标识和开发密钥不是正式用户认证。该功能只帮助验证连接、心跳和 Redis 路由;不能把探针通过报告为聊天业务或生产鉴权完成。