Open API / 概述
概述
Open 向调用方服务端开放能力。接入一次签名与 AppID,即可按接口分别调用。左侧「接入」是通用规范,「API」是具体接口,后续每增加一个能力只加一条菜单。
私钥只保存在调用方服务端,用于计算
X-YS-Signature。禁止放入客户端、App、浏览器或业务 JSON。阅读顺序
- 接入准备:拿到 AppID 与对接人员交付的私钥。
- 环境与地址:Base URL、探活、文档地址。
- 签名规范:所有接口共用同一套
X-YS-*头和待签串。 - 多语言:请求头
Accept-Language(zh-Hans/en/ko/ja)。 - 打开具体 API 页,按该接口的字段、错误码和示例对接。
- Swagger UI:接口 schema 与在线试调,
env=prod关闭。
API 目录
推送支付密码
POST /v1/system-push/pay-password 业务触发支付密码,后端生成后发到 IM,IM 回填后继续业务。
同步 IM 建号
POST /v1/im/account/sync 按众享号建本地号并导入腾讯云 IM。已有映射只补导入;可选 location 写入标准资料字段。
众享空间下载地址
GET /v1/h5/app-download H5 取安卓 / iOS 下载地址,无需 RSA。
站点协议
GET /v1/h5/protocols H5 拉用户协议 / 隐私政策,无需 RSA。
H5 注册绑推荐人
GET /v1/h5/invite、POST /v1/h5/sms/code、/v1/h5/register 落地页查邀请人、注册并绑定邀请码。