API开发文档简介
本文阅读对象:使用云易助手APP用户。通过本文档,用户可了解 云易助手 接入APP的api、提交数据、接入的流程、接入规范等信息,以便于APP顺利完成接入工作。
云易助手对接软件API地址是:https://iappy.cn
API接口申请方式
共有两种接口模式:
(一)无加密模式
(二)加密模式
API协议接入规则
传输方式:HTTP
数据格式:JSON
字符编码:UTF-8
API登录账号
请求方式:POST
URL地址:https://iappy.cn/api.php
请求参数说明
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
操作类型 | type | 是 | String | Signin | 此API固定值 |
应用ID | ID | 是 | Int | 1 | |
应用KEY | key | 是 | String | jejw64518191961HN4nUzUJ8i | |
登录账号 | user | 是 | String | 1234 | |
登录密码 | pass | 是 | String | 1234 | |
设备识别码 | imei | 是 | String | i649191jw646191 | |
返回结果
字段名 | 变量名 | 类型 | 示例值 | 描述 |
返回状态码 | code | Int | 1 | 1为成功,其它值为失败 |
返回提示 | msg | String | 登录失败 | |
用户账号 | user | String | 1234 | |
用户昵称 | name | String | 雨莫 | |
用户QQ | QQ | Int | 2789599771 | |
注册时间 | time | String | 2020年8月4日 | 1为正常,0为封禁 |
用户金币 | Goldcoin | Int | 10 | 用户所拥有的金币数量 |
会员状态/时间 | Member | String | 2020年8月5日 22:58:28 | 返回无则视为不是会员显示时间则是会员到期时间 |
API注册账号
请求方式:POST
URL地址:https://iappy.cn/api.php
请求参数说明
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
操作类型 | type | 是 | String | register | 此API固定值 |
应用ID | ID | 是 | Int | 1 | |
应用KEY | key | 是 | String | jejw64518191961HN4nUzUJ8i | |
注册的账号 | user | 是 | String | 1234 | |
注册的密码 | pass | 是 | String | 1234 | |
设备识别码 | imei | 是 | String | i649191jw646191 | |
用户QQ号 | QQ | 是 | Int | 2789599771 | |
新账号昵称 | name | 是 | String | 雨莫 | |
返回结果
字段名 | 变量名 | 类型 | 示例值 | 描述 |
返回状态码 | code | Int | 1 | 1为成功,其它值为失败 |
返回提示 | msg | String | 注册成功 | |
API使用卡密
请求方式:POST
URL地址:https://iappy.cn/api.php
请求参数说明
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
操作类型 | type | 是 | String | Kalman | 此API固定值 |
应用ID | ID | 是 | Int | 1 | |
应用KEY | key | 是 | String | jejw64518191961HN4nUzUJ8i | |
用户账号 | user | 是 | String | 1234 | |
卡密号 | km | 是 | String | 6464jsjnw349JkdnU4684 | |
返回结果
字段名 | 变量名 | 类型 | 示例值 | 描述 |
返回状态码 | code | Int | 1 | 1为成功,其它值为失败 |
返回提示 | msg | String | 注册成功 | |
API检查更新
请求方式:POST
URL地址:https://iappy.cn/api.php
请求参数说明
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
操作类型 | type | 是 | String | Update | 此API固定值 |
应用ID | ID | 是 | Int | 1 | |
应用KEY | key | 是 | String | jejw64518191961HN4nUzUJ8i | |
返回结果
字段名 | 变量名 | 类型 | 示例值 | 描述 |
最新版本号 | Edition | String | 1.0 | |
更新内容 | Updatecontent | String | 本次更新更新了个寂寞 | |
更新链接 | updatelink | String | https://iappy.cn | |
API获取公告
请求方式:POST
URL地址:https://iappy.cn/api.php
请求参数说明
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
操作类型 | type | 是 | String | Notice | 此API固定值 |
应用ID | ID | 是 | Int | 1 | |
应用KEY | key | 是 | String | jejw64518191961HN4nUzUJ8i | |
返回结果
字段名 | 变量名 | 类型 | 示例值 | 描述 |
返回状态码 | code | Int | 1 | 1为成功,其它值为失败 |
返回提示 | msg | String | 获取成功 | |
公告内容 | Notice | String | 哈哈哈哈这是公告内容 | |
API获取商品
请求方式:POST
URL地址:https://iappy.cn/api.php
请求参数说明
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
操作类型 | type | 是 | String | commodity | 此API固定值 |
应用ID | ID | 是 | Int | 1 | |
应用KEY | key | 是 | String | jejw64518191961HN4nUzUJ8i | |
返回结果
字段名 | 变量名 | 类型 | 示例值 | 描述 |
商品列表 | commodity | Array | | |
API获取广告
请求方式:POST
URL地址:https://iappy.cn/api.php
请求参数说明
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
操作类型 | type | 是 | String | advertisement | 此API固定值 |
应用ID | ID | 是 | Int | 1 | |
应用KEY | key | 是 | String | jejw64518191961HN4nUzUJ8i | |
返回结果
字段名 | 变量名 | 类型 | 示例值 | 描述 |
广告列表 | advertisement | Array | | |
API用户签到
请求方式:POST
URL地址:https://iappy.cn/api.php
请求参数说明
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
操作类型 | type | 是 | String | sign | 此API固定值 |
应用ID | ID | 是 | Int | 1 | |
应用KEY | key | 是 | String | jejw64518191961HN4nUzUJ8i | |
用户账号 | user | 是 | String | 1234 | |
用户密码 | user | 是 | String | 1234 | |
返回结果
字段名 | 变量名 | 类型 | 示例值 | 描述 |
返回状态码 | code | Int | 1 | 1为成功,其它值为失败 |
返回提示 | msg | String | 签到成功 | |
API反馈提交
请求方式:POST
URL地址:https://iappy.cn/api.php
请求参数说明
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
操作类型 | type | 是 | String | feedback | 此API固定值 |
应用ID | ID | 是 | Int | 1 | |
应用KEY | key | 是 | String | jejw64518191961HN4nUzUJ8i | |
用户账号 | user | 是 | String | 1234 | |
用户密码 | user | 是 | String | 1234 | |
反馈内容 | content | 是 | String | 哈哈哈哈这是反馈内容 | |
返回结果
字段名 | 变量名 | 类型 | 示例值 | 描述 |
返回状态码 | code | Int | 1 | 1为成功,其它值为失败 |
返回提示 | msg | String | 签到成功 | |
API商品支付(特殊)
请求方式:无
URL地址:https://iappy.cn/purchase.php?ID={商品id}&key={配置key}&llD={配置ID}&type={支付方式如:wxpay}&user={用户账号}&pass={用户密码}
这里说一下这个支付是个例外,支付要先把变量链接组合起来然后提交赋值给浏览器
请求参数说明
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
商品ID | ID | 是 | Int | 1 | |
应用ID | IID | 是 | Int | 1 | |
应用KEY | key | 是 | String | jejw64518191961HN4nUzUJ8i | |
支付方式 | type | 是 | String | wxpay | |
用户账号 | user | 是 | String | 1234 | |
用户密码 | pass | 是 | String | 1234 | |