Appearance
渠道对接指南
本指南将引导您完成与AIDOL系统的技术对接,实现用户自动登录、余额查询、扣款、退款等功能。
先读这一页
渠道接入有两类内容:
- 服务端回调接口:AI-DOL 服务端会调用你方提供的接口(余额查询、扣款、退款、设备列表等),接口域名由你方提供。
- 移动端桥接规范:H5 页面通过
window.nativeBridge.*与原生交互(收银台、关闭页面、指令推送等)。
对接前置
你需要从 AI-DOL 获取以下凭证:
| 字段 | 说明 |
|---|---|
channelId | 渠道标识 |
apiKey | 请求头 Authorization: Bearer <apiKey> |
apiSecret | 用于生成签名 X-Signature |
签名与通用规范见:接口规范定义。
对接流程概览
获取凭证:从AI-DOL获取您的专属
channelId、apiKey和apiSecret提供域名:将您的接口服务域名提供给我们
实现接口:根据本指南实现所需的接口
联调测试:双方进行接口联调测试
正式上线:测试通过后切换至生产环境
重要提示:请先完成测试环境对接验证,再切换生产环境。
文档目录
| 页面 | 用途 |
|---|---|
| 自动登录集成 | 用户从渠道侧一键跳转到 AI-DOL 并自动登录 |
| 接口规范定义 | 通用响应、请求头、签名算法 |
| 用户余额查询 | AI-DOL 调用你方接口查询余额 |
| 套餐兑换 | 用户在 AI-DOL 兑换套餐时的回调 |
| 扣款 | AI-DOL 侧消费扣款回调 |
| 退款 | AI-DOL 侧退款回调 |
| 收银台支付 | H5 拉起原生收银台与支付结果回调 |
| 关闭页面 | H5 触发原生关闭当前 WebView |
| 获取用户硬件(设备)信息 | AI-DOL 侧获取用户设备列表 |
| 广播指令推送 | H5 触发原生向全部设备广播指令 |
| 定向指令推送 | H5 触发原生向指定设备发送指令 |
| 修订记录 | 版本与变更说明 |