Youloge.RPC 通信协议

创建时间：2023-08-13 02:29:24

更新时间：2025-10-29 22:09:00

作者：Micateam

概述

Youloge.RPC 是一个有状态，需要路由匹配的，轻量级远程调用协议。它非常适合用在前端-后端，后端-后端，代理-节点等方面使用。

约定

• 公共接口 https://api.youloge.com 私有接口 https://vip.youloge.com
• 请求方式 POST 请求路径 :routed/:method
• 请求标头 content-type:application/json
• 请求标头 Organization:${APIKEY}
• 请求标头 Authorization:${access_token}
• 请求内容 []{}

请求标头

• Organization 请求组织，用于区分开发者
• Authorization 认证签名Token 用于区分用户
• 公共接口允许跨域 私有接口不支持跨域且必须固定IP调用

简单请求

• 完整请求URL为 https://api.youloge.com/login/code

--> login/code
{"id":"","captcha":"","mail":"0000@youloga.com"}
<-- login/code 
{"id":"","result":{"uuid":"userID","name":"name"...}}
<-- login/code
{"id":"","error":{"code":"","message":""}}

标准JSONRPC请求

• 完整请求URL为 https://api.youloge.com

--> login/code
{"id":"","method":"login/code","params":{"captcha":"","mail":"0000@youloga.com"}}
<-- login/code 
{"id":"","result":{"uuid":"userID","name":"name"...}}
<-- login/code
{"id":"","error":{"code":"","message":""}}

批量请求

• 对统一接口进行多个处理

--> login/code
[{"id":"","captcha":"","mail":"0000@youloga.com"},{"captcha":"","mail":"0000@youloga.com"}]
<-- login/code 
[{"id":"","msg":"success","data":{"uuid":"userID","name":"name"...}},{"id":"","msg":"success","data":{"uuid":"userID","name":"name"...}}]
<-- login/code
[{"err":401,"msg":"error"},{"err":401,"msg":"error"}]

接口调用（CURL）

curl 'https://www.youloge.com/captcha/verify' \
  -H 'accept: */*' \
  -H 'accept-language: zh-HK,zh;q=0.9,en-HK;q=0.8,en-US;q=0.7,en;q=0.6,zh-CN;q=0.5' \
  -H 'organization: XXXXXFRmWZP8Tg' \
  -H 'authorization: XXXXXZP8TgFRmW' \
  -H 'content-type: application/json' \
  -H 'user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/129.0.0.0 Safari/537.36' \
  --data-raw '{"expire":1727372022,"signature":"TeZMph_7DeXGf6OelQl"}'

消息订阅(Websocket) req(请求数据) sub(订阅数据) unsub(取消订阅)

• 完整请求URL为 wss://chat.youloge.com/live?signature=?
• 完整请求URL为 wss://api.youloge.com/subscribe
• id 调用的唯一标识，后端原样返回
• method 请求调用方法
• params 请求调用参数

<---> 000 - 101 - 200 subscribe
// 订阅数据
---> {"id":"123-xxx-xxx-xxx","method":"live.sub","params":{"room":"1000"}}
<--- {"id":"xxx-xxx-xxx-xxx","result":{"status":"ok"}}
// 请求数据
---> {"id":"xxx-xxx-xxx-123","method":"live.online"}
<--- {"id":"xxx-xxx-xxx-123","result":{"online":1024}}
// 批量调用
<--- [{"id":"xxx-xxx-xxx-123","method":"live.online"},{"id":"xxx-xxx-xxx-123","method":"live.online"}]
---> [{"id":"xxx-xxx-xxx-123","result":{"online":1024}},{"id":"xxx-xxx-xxx-123","result":{"online":1024}}]
// 链接心跳保持
---> {"method":"ping","params":123456789}
<--- {"id":200,"result":123456789}

规范错误码

通用错误码 error.code

错误码	说明
200	正确返回
401	请求头格式错误
402	请求头使用场景错误
403	组织/认证 授权已过期
405	请求方法错误
406	请求参数错误
408	批量请求部分错误
409	批量请求参数错误

业务错误码 - error.code

错误码	说明
310100	具体业务错误
310101	具体业务错误
Login.UserIDNull	具体业务错误
Login.ParamError	具体业务错误

解构310100 错误码

• 31 为 login 类业务编号
• 01 为 method 方法编号
• 00 为 error 错误类型