1. 文档
网络验证客户端
  • 网络验证安装文档
  • 文档
    • 系统使用文档
    • 接口文档
    • 错误码列表
    • 参数加密
    • 签名与验签
    • 使用云函数
  • 单码应用业务接口
    • 单码登录接口
      GET
    • 取单码信息(未登录)
      GET
    • 取单码信息(已登录)
      GET
    • 单码解绑
      GET
    • 执行云函数(已登录)
      GET
    • 修改绑定信息(已登录)
      GET
    • 单码心跳接口(已登录)
      GET
  • 账户密码应用业务接口
    • 用户注册
      GET
    • 用户充值
      GET
    • 用户登录
      GET
    • 取账户信息(未登录)
      GET
    • 用户解绑
      GET
    • 用户心跳接口(已登录)
      GET
    • 修改密码(未登录)
      GET
    • 修补绑定信息(已登录)
      GET
  • 公共接口
    • 取单码/账户的绑定值
      GET
    • 取程序公告
      GET
    • 取程序简介
      GET
    • 退出登录
      GET
    • 取程序版本更新
      GET
    • 下载文件接口
      GET
  1. 文档

接口文档

HTTP#

基础业务请求模型流程图#

image.png
HTTP为单向通讯,由客户端主动发起请求,服务端接收请求后做出相应的业务逻辑

TCP#

TCP的请求流程模型与HTTP一致

请求地址:#

在进行TCP请求时需要改接口地址将其的端口改为:9091
例如:单码登录接口http://域名/open_api/v1/user_app/login其TCP链接地址即为域名:9091

参数格式:#

进行TCP请求时需要将参数使用GET请求的格式将其拼接起来,并加上url参数

例如使用TCP请求进行单码登录#

HTTP接口地址:http://域名/open_api/v1/user_app/login
HTTP接口参数:card/app_code/machine等
TCP请求地址:域名:9091
TCP发送参数:card=卡密&app_code=应用编号&machine=机器码&url=/v1/user_app/login
所有接口均为如此
💡
与HTTP不同的是:TCP在与服务端链接成功后,服务端首先会向客户端发送一条消息链接成功
然后客户端再进行参数发送,服务器对逻辑处理后返回消息
在进行完成业务处理后,应由客户端首先断开链接,一条TCP仅对应一个逻辑
(即在进行完成单码登录后,客户端应断开链接,在进行心跳时再重新取得链接,尽量避免TCP一直挂在服务端上,避免多余资源的开销)

接口预览#

💡

统一接口风格#

接口地址组成为:
域名/模块名/接口版本/控制器/动作
例如
域名/open_api/v1/single_app/login

接口分类:#

应用类型为单码应用的,仅可使用单码应用接口和公共接口
应用类型为账户密码应用的,仅可使用账户密码接口和公共接口

参数类型:#

参数分为三种类型:
1、基础参数:例如app_code用于区分应用(基础参数必传)
2、业务参数:根据不同的接口业务传入不同的业务值(必填)
3、安全参数:通过安全参数增强接口安全(根据后台选择传入)

请求方法:#

所有接口均支持GET/POST请求
GET请求:将参数拼接至接口后方(例如 单码接口?card=单码&app_code=应用编号 无顺序区别)
POST请求:需设置请求头Content-Type为application/x-www-form-urlencoded或multipart/form-data
接口凡是后面带(已登录的)均需要传入token

单码应用接口#

单码登录接口
取单码信息(未登录)
取单码信息(已登录)
单码解绑
执行云函数(已登录)
修改绑定信息(已登录)
单码心跳接口(已登录)

账户密码应用接口#

用户注册
用户充值
用户登录
取账户信息(未登录)
用户解绑
用户心跳接口(已登录)
修改密码(未登录)
修补绑定信息(已登录)

公共接口#

取单码/账户的绑定值
取程序简介
取程序公告
退出登录
取程序版本更新
修改于 2024-09-29 08:28:47
上一页
系统使用文档
下一页
错误码列表
Built with