接口协议
除非特殊指定,默认HTTP/HTTPS标准协议传输。
字符编码
除非特殊指定,默认字符编码均为UTF-8编码格式。
请求方式
除非特殊指定,默认以下方式
1、GET
2、POST
请求格式
接口内如果没有特殊说明的,默认使用以下
1、Accept类型统一为:application/json;charset=utf-8
2、Content-Type类型统一为: application/json。
URL编码
由于可能包含非ASCII字符和路径非法字符,所有调用API接口参数,请使用urlencode方式表达。
返回数据格式
除非特殊指定,默认返回数据格式均为JSON格式。
返回结构说明
名称 | 类型 | 说明 |
---|---|---|
code | int | 返回结果状态码 0失败,1成功 |
msg | String | 返回信息提示,成功默认:SUCCESS,错默认:ERROR |
data | Object | 根据不同接口,返回不同结果集 |
成功信息返回样例:
{
"code": 1,
"msg": "SUCCESS",
"data":
{
"location": "125.38836241563658,43.84524673299741",
"timestamp": 1582021433553
}
}
失败信息返回样例:
{
"code": 0,
"msg": "ERROR",
"data": null // 错误返回默认null,或错误信息结果集
}
其他说明
除非特殊指定,所有接口
1、涉及坐标位置的参数,默认使用高德坐标系。
2、涉及时间戳的参数,默认为毫秒级。
3、涉及公里的参数,默认为公里。
4、涉及时间的参数,默认为分钟。
5、涉及金额的参数,默认为元,四舍五入,保留两位。