OPEN_API接口文档
  1. 文档
OPEN_API接口文档
  • 文档
    • 接口文档
    • 云函数最佳使用
    • CLI使用教程
    • 普通请求
    • 加密请求
    • 接口管理-接口拓展
  • 单码接口
    • 获取单码信息接口
      GET
    • 单码登出
      GET
    • 单码心跳接口
      GET
    • 单码登录
      GET
    • 单码解绑
      GET
  • 会员接口
    • 用户登录
      GET
    • 获取会员信息(已登录)
      GET
    • 用户注册
      GET
    • 用户登出
      GET
    • 用户心跳
      GET
    • 获取会员信息(未登录)
      GET
    • 用户解绑
      GET
    • 用户充值
      GET
    • 修改密码(已登录)
      GET
    • 修改密码(未登录)
      GET
    • 修改昵称
      GET
    • 查询工单类型
      GET
    • 添加新的反馈主题
      GET
    • 获取已登录用户的所有反馈主题
      GET
    • 获取反馈主题下的聊天记录
      GET
    • 发送聊天消息
      GET
  • 通用接口
    • 获取程序变量
    • 获取程序版本列表
    • 获取最新版本
    • 云函数
    • 设置私有数据
    • 获取私有数据
  1. 文档

接口文档

接口使用说明#

📌
首先您必须要清楚,GET方法传参格式为a=1&b=2
POST方法传参格式为{"a":1,"b":2}

请求头和请求方法#

请求头如果在接口中没有特别表示,则不需要请求头
请求方法,所有的接口全部支持 GET和POST请求

请求#

公共参数#

APPID#

appId 即 应用管理 -> 应用中心 -> 应用编号
使用该字段区分不同开发者的不同应用
如果不传入该字段,您的一切请求均无法正常使用
系统将返回请传入APPID

safeCode#

safeCode为随机数 即 接口管理 -> 接口安全 -> 随机数防劫持控制开关
使用该字段可防止数据被劫持:
在请求时生成随机数,然后服务端在接收到该随机数时将原封不动传回,如果被中间代理静态劫持注入,第二次请求与第一次请求生成的随机数不相同,在客户端即可完成被劫持的判定!
当开启时,所有请求必须传入该字段
关闭时该字段即使传入也不会返回

signature#

signature为签名 即 接口管理 -> 接口安全 -> 签名方式
开启后,需要根据选择的 接口管理 -> 接口安全 -> 签名计算规则 对请求参数或响应参数进行签名

timestamp#

timestamp为13位时间戳 即接口管理 -> 接口安全 -> 服务端签名验证时间差
当输入框内填入的非0时 , 需要在接口中传入 timestamp,服务器将验证该请求的时间是否存在问题
算法:(服务器时间 - 接口传入的timestamp)*1000 与输入框内您输入的时间做比较
若 前者大于后者则该请求无效,反之则通过时间戳校验

私有参数#

私有参数可以理解为每个接口独特需要传入的参数
例如,单码登录接口必定要传入单码,但是获取最新版本接口可以不传入单码

响应#

响应的结构为
参数名参数介绍参数类型
code业务逻辑码int
msg业务逻辑提示string
signature响应签名string
timestamp响应时间(13位时间戳)long
data业务逻辑额外数据json

接口调用模型#

请求模型#

响应模型#

下一页
云函数最佳使用
Built with