HTTP API使用说明
1.所有接口返回值均为json格式,例如{"version":"1.0.1","code":0},code字段不为0则调用错误,数据返回请自行调用查看。
2.端口固定为8080,请先排除本地端口占用,导致http服务无法开启。
3.setcurrentrecordparam使用前先设置参数在/var/mobile/ctwparams.txt文件中
4.需要修改ID的接口记录名后使用getbakidfromname接口获取ID可以调用。
接口列表
以客户端的IP通用,这里使用127.0.0.1举例
- 获取版本号:通过请求http://127.0.0.1:8080/version来获取客户端的版本号。
- 一键新机:通过请求http://127.0.0.1:8080/newrecord来清空所有记录并新建一条记录。
- 下一条记录:通过请求http://127.0.0.1:8080/nextrecord来获取下一条记录。
- 清除所有记录:通过请求http://127.0.0.1:8080/deleteallrecords来清空所有记录。
- 生效指定记录:通过请求 http://127.0.0.1:8080/activerecord?ID=XXX 来生效指定的记录,其中 XXX 为记录的 ID。
- 生效第一条:通过请求http://127.0.0.1:8080/activefirstrecord来生效第一条记录。
- 生效最后一条记录:通过请求 http://127.0.0.1:8080/activelastrecord 来生效最后一条记录。
- 删除指定记录:通过请求 http://127.0.0.1:8080/deleterecord?ID=XXX 来删除指定的记录,其中 XXX 为记录的 ID。
- 直接导入记录:通过请求http://127.0.0.1:8080/importdirect来导入记录。
- 导出指定记录:通过请求http://127.0.0.1:8080/exportrecord?ID=XXX来导出指定的记录,其中XXX为记录的ID。
- 导出所有记录:通过请求http://127.0.0.1:8080/exportallrecords来导出所有记录。
- 重命名当前记录:通过请求 http://127.0.0.1:8080/renamecurrentrecord?name=XXX 来重命名当前记录为 XXX。注:中文请使用URL编码。
- 记录名查ID:通过请求http://127.0.0.1:8080/getbakidfromname?name=XXX来查找记录名为XXX的记录的ID。
- 获取当前记录参数:通过请求http://127.0.0.1:8080/getcurrentrecordparam来获取当前记录的参数。
- 设置当前记录参数:需要先将参数设置在 /var/mobile/ctwparams.txt 文件中,然后通过请求 http://127.0.0.1:8080/setcurrentrecordparam 来设置当前记录的参数。1.5.2以后不再支持,请帮助文档中通过客户识别码下发自定义参数的描述。
- 禁用禁用APP:通过请求http://127.0.0.1:8080/enablerecordapp设置参数bid=bundle id,参数enable=1或0,来启用或禁用当前记录的APP。
- 获取所有记录的名称列表:通过请求http://127.0.0.1:8080/getallrecordsname来获取所有记录的名称列表。
- 修改GPS定位:通过请求 http://127.0.0.1:8080/relocationwithbid 来修改GPS定位。设置参数x,y,z,r,bid - 经纬度,地域,随机范围,bundle id
- 下载二维码分享的配置:通过请求http://127.0.0.1:8080/loadcloudconfig?device_id=下载二维码分享的配置,参数为分享的设备ID。
OpenURL指令说明:
| 功能 | 代码 |
|---|---|
| 启动应用 | openURL("CTW://?cmd=open"); |
| 一键新机 | openURL("CTW://?cmd=newrecord"); |
| 下一条记录 | openURL("CTW://?cmd=nextrecord"); |
| 清除所有记录 | openURL("CTW://?cmd=deleteallrecords"); |
| 生效指定记录 | openURL("CTW://?cmd=activerecord&ID="); |
| 生效第一条 | openURL("CTW://?cmd=activefirstrecord"); |
| 生效最后一条 | openURL("CTW://?cmd=activelastrecord"); |
| 删除指定记录 | openURL("CTW://?cmd=deleterecord&ID="); |
| 直接导入记录 |
openURL("CTW://?cmd=importdirect"); 导入记录放在/var/mobile/Media/CTWImport/下 |
| 导出指定记录 |
openURL("CTW://?cmd=exportrecord&ID="); 导出记录在/var/mobile/Media/CTWExport/下 |
| 导出所有记录 |
openURL("CTW://?cmd=exportallrecords"); 导出记录在/var/mobile/Media/CTWExport/下 |
| 重命名当前记录 |
openURL("CTW://?cmd=renamecurrentrecord&name="); 重命名记录名。注:中文请使用URL编码。 |
| 记录名查ID |
openURL("CTW://?cmd=getbakidfromname&name="); 根据记录名查ID |
| 获取当前记录参数 |
openURL("CTW://?cmd=getcurrentrecordparam"); 获取的参数在/var/mobile/ctwparams.txt文件中 |
| 设置当前记录参数 |
openURL("CTW://?cmd=setcurrentrecordparam"); 设置的参数在/var/mobile/ctwparams.txt文件中。1.5.2以后不在支持,请查看帮助文档中通过客户识别码下发自定义参数的描述。 |
| 启用禁用APP |
openURL("CTW://?cmd=enablerecordapp"); 设置参数bid=bundle id,参数enable=1或0是否启用 |
| 获取所有记录名列表 |
openURL("CTW://?cmd=getallrecordsname"); 获取的记录名列表在/var/mobile/ctwrecords.txt文件中 |
| 修改GPS定位 |
openURL("CTW://?cmd=relocationwithbid"); 设置参数x,y,z,r,bid - 经纬度,海拔,随机范围,bundle id |
| 下载二维码分享的配置 |
openURL("CTW://?cmd=loadcloudconfig&device_id="); 参数为分享的设备ID |
指令返回值说明:
返回值在:/var/mobile/ctwresult.txt文件中| 返回值 | 说明 |
|---|---|
| 0 | 指令执行正常完成。 |
| 1 | 指令执行出错。 |
| 2 | 指令正在执行过程中,还未完成。 |
| 4 | 下一条记录已到最后一条(仅针对nextrecord指令)。 |
ctwparams.txt参数文件说明:
获取或设置当前记录参数在:/var/mobile/ctwparams.txt文件中;每一行一个参数,换行符为: chr(10);
参数名与参数值之间,使用冒号(:)隔开;
可通过调用指令getcurrentrecordparam后,打开该文件查看格式。
| 参数名称 | 说明 |
|---|---|
| RecordID | 记录ID,如:"微信001"。 |
| RecordName | 记录名,默认自动生成。 |
| DeviceName | 设备名称,如:"xxxx iPhone"。 |
| SystemVersion | 系统版本号,如:"10.3.1"。 |
| IDFA | IDFA值。 |
| IDFV | IDFV值。 |
| UDID | 设备UDID值。 |
| IMEI | 设备IMEI值。 |
| SerialNum | 设备序列号。 |
| MAC | MAC地址。 |
| SSID | SSID值。 |
| BSSID | BSSID值。 |
