Appearance
公共约定
调用入口
调用API的服务URL地址，文档中所有接口都使用该url访问
| 调用环境 | 服务地址(HTTP) |
|---|---|
| 国内正式环境 | http://open.aichezaixian.com/route/rest |
| 国外正式环境 | http://open.10000track.com/route/rest |
约定
服务器默认采用UTF-8编码，数据采用JSON格式
请求：Context-Type:application/x-www-form-unlencoded响应：Context-Type:application/json charset=utf-8
时间统一采用UTC时间，国内是北京时间，格式yyyy-WM-dd HH:mm:ss
国外环境，时间是要时区UTC时间，格式yyyy-WM-dd HH:mm:ss
返回数据公共属性
| 参数 | 类型 | 必须 | 描述 |
|---|---|---|---|
| code | Int | 是 | 结果码 |
| message | String | 否 | Code描述 |
Code解释
| code | 值 | 描述 |
|---|---|---|
| -1 | -1 | 系统繁忙 |
| 0 | 0 | 成功 |
| 1xxx | 1001 | 参数错误(缺少必选参数或格式错误)，具体查看接口描述 |
| 1002 | 非法用户/非法设备(查询的账号或设备不是自己的或下级的) | |
| 1003 | 重复提交操作 | |
| 1004 | 非法访问,token异常!(token失效或不存在) | |
| 1005 | 非法访问,ip访问超过限定次数! | |
| 1006 | 非法访问,请求频率过高! | |
| 1007 | 非法访问,请求方法错误! | |
| 1008 | 非法访问,来路异常! | |
| 12001 | 创建平台账号操作失败 | |
| 12002 | 转移设备操作失败 | |
| 12003 | 创建电子围栏操作失败 | |
| 12004 | 删除电子围栏操作失败 | |
| 12005 | 发送指令失败 | |
| 12006 | 更新设备信息失败 | |
| 12007 | 当前围栏名称已存在 | |
| 12008 | 围栏超过创建个数 | |
| 12009 | 围栏名称存在特殊字符 | |
| 12010 | 保存围栏告警失败 | |
| 12011 | 非法用户,删除围栏失败 | |
| 12012 | 删除围栏失败 |
业务错误码
| 业务 | 错误码 | 描述 |
|---|---|---|
| 创建账号 | 213 | 账号已存在 |
| 214 | 操作账号不存在 | |
| 215 | 用户类型错误，可能原因：1,新建用户类型为空;2,新建用户类型不存在;3,当前登录用户无权限新加该类型用户 | |
| 100001 | 没有创建平台账号的权限 | |
| 转移设备 | 217 | 目标用户不存在 |
| 218 | 操作用户只能往下级用户转移/销售设备 | |
| 219 | imei列表不合法 | |
| 220 | imei数量超出限制 | |
| 修改设备 | 223 | 车辆图标无效 |
| 电子围栏 | 41001 | 超过机型支持围栏数 |
| 41002 | 围栏名已存在 | |
| 41003 | 设备不在线 | |
| 41004 | 电子围栏操作失败 | |
| 41005 | 电子围栏不存在 | |
| 41006 | 不支持创建电子围栏 | |
| 指令 | 225 | 超时 |
| 226 | 参数错误 | |
| 227 | 指令未正确执行 | |
| 228 | 设备不在线 | |
| 229 | 网络错误，连接断开等 | |
| 238 | 设备中断 | |
| 240 | 数据错误 | |
| 243 | 设备不支持 | |
| 252 | 设备忙 | |
| 255 | 设备成功 |
接口调用限制/频次说明
| 接口 | 说明 |
|---|---|
| 认证API | 固定访问频次，1分钟只能调用一次，1440次/天，每天零点重新计 |
| 其他接口 | 访问频率不能超过100次/秒，默认1440次/天，每天零点重新计算实际访问频次：申请账号名下设备(含下级) * 10 计算，小于1440按1440计算如果需要更高的访问频率授权，请联系我们。 |
| 消息服务 | 为减少系统无效的推送，服务器会禁用无效的推送地址判定规则：连续3天存在推送失败，运维人员手动测试，调用不通的将被禁止 |