墨西哥APP原始接口文档
dev环境域名
test环境域名
prod环境域名
文档说明
混淆:
- 重要: !!请完全遵照混淆原则-不要使用原始字段请求接口
因审核需要,原始接口中的参数(包括部分值)需要混淆传递, 如因混淆造成困扰,可以使用如下工具在混淆和原始值之间转义
转义工具:
1.project输入文档链接后缀 如: http://47.103.73.105:8090/mexico-xxx 就输入ksp-xxx
2.!!!如要转义单个字符 请在输入框输入( "xxxxx":) 格式带上双引号和冒号,可转义单个字段
干扰字段:
1.为了接口差异化,接口请求入参及接口响应出参会包含一些无用的干扰字段
2.入参干扰字段: 请参照文档标注的干扰字段传参,值可以任意传递,但注意不要传递如aaa bbb 123这种固定简单的没有意义的值, 建议传递随机密码串,或者写个字典函数随机英文单词等形式
3.接口出参: 出参每次会有不同的干扰字段,忽略即可
请求地址:
1.使用后端提供的基础域名拼接接口地址,接口地址也需要混淆
2.文档中地址已是混淆后的,可直接使用
动态域名:
动态域名功能,在主域名请求不通时,应动态切换到配置下发的域名,其中包括接口api域名和H5域名 后端会提供两个及以上的配置文件获取地址,根据地址下载文件中的内容
- 说明: 文件中内容是base64加密过的,需转换后得到两个地址 转换后内容如下(键名已混淆)
[
{
"api":"http://8.215.65.001:8000",
"h5":"http://8.215.65.001"
}
]
APP接口固定请求头参数
固定参数使用url参数方式传递
名称 | 类型 | 注释 |
---|---|---|
"clientType": | string | 终端版本,取值范围: android |
"appVersion": | string | App版本,例如:1.0.0 |
"deviceName": | string | 设备名称,例如:iphoneX |
"deviceId": | string | 设备ID |
"Crdkk": | string | 干扰字段(2k3) |
"osVersion": | string | 设备os版本,例如:11.2/8.0.0 |
"appMarket": | string | 市场 |
"sessionId": | string | SessionId |
"gps_adid": | string | gps_adid |
"mobilePhone": | string | 手机号 |
"CrPkk": | string | 干扰字段(dkam) |
"appName": | string | app标识 |
"packageId": | string | 包名 |
"merchantName": | string | 商户名 |
"eventLk": | string | 干扰字段(cedpa) |
请求头
- POST方式通用接口请求头
Content-Type:application/x-www-form-urlencoded
- 个别接口会使用
Content-Type:multipart/form-data
(例如:图片上传) 、Content-Type:application/json
(例如:数据上报) 会在具体接口文档中指定
错误码规范
错误码 | 注释 |
---|---|
0或00 | 成功 |
-1 | 系统通用错误,未指定具体错误码 |
-2 | 未登录 |
其他 | 其他错误码 |