管理規(guī)范 集團(tuán)（公司）物流管理接口開發(fā)規(guī)范文檔V3

管理規(guī)范

集（公司）物流管理接口

開發(fā)規(guī)范文檔

文件編號202XQK011/BT-ZTA-QK011

文件狀態(tài)［］草稿［?］正式發(fā)布［］正在修改

當(dāng)前版本

擬制日期

審核日期

日期版本變更內(nèi)容作者

1.0初稿

1.1修正

1.2新增新產(chǎn)品功能

目錄

第一章文檔說明5

第二章返值定義7

2.1.公共接口7

2.1.1.驗(yàn)證碼發(fā)送接口7

2.1.2.驗(yàn)證碼驗(yàn)證接口9

2.1.3.圖片驗(yàn)證碼接口11

2.1.4.圖片驗(yàn)證碼接口12

2.2.用戶管理接口13

2.2.1.用戶名校驗(yàn)接口13

2.2.2.手機(jī)號是否已綁定接口15

2.2.3.用戶注冊接口16

2.2.4.用戶登錄驗(yàn)證接口20

2.2.5.用戶信息修改接口22

2.2.6.用戶密碼修改接口25

2.2.7.用戶重設(shè)密碼接口26

2.2.8.用戶信息獲取接口28

2.2.9.通過手機(jī)號獲取用戶信息接口32

2.2.10.用戶手機(jī)號修改接口34

2.2.11.用戶頭像上傳接口35

2.2.12.新增監(jiān)控賬號接口37

2.2.13.修改監(jiān)控賬號接口39

2.2.14.刪除監(jiān)控賬號接口41

2.2.15.監(jiān)控賬號列表查詢接口42

2.2.16.監(jiān)控賬號檢查接口44

2.2.17.微信綁定接口46

2.2.18.微信解綁接口47

2.3.用戶個人設(shè)置接口49

2.3.1.常用點(diǎn)位列表信息查詢接口49

2.3.2.常用點(diǎn)位信息保存接口51

2.3.3.常用預(yù)設(shè)路徑列表信息查詢接口52

2.3.4.常用預(yù)設(shè)路徑新增接口55

2.3.5.常用預(yù)設(shè)路徑修改接口57

2.3.6.單個預(yù)設(shè)路徑查詢接口59

2.3.7.單個預(yù)設(shè)路徑刪除接口61

2.4.設(shè)備管理接口63

2.4.1.根據(jù)終端號查詢設(shè)備信息接口63

2.4.2.設(shè)備默認(rèn)參數(shù)獲取接口68

2.4.3.終端預(yù)新增接口72

2.4.4.終端新增接口77

2.4.5.終端修改接口80

2.4.6.組內(nèi)設(shè)備最近上報信息查詢接口83

2.4.7.單個設(shè)備歷史上報信息查詢接口86

2.4.8.單個設(shè)備歷史上報信息導(dǎo)出接口90

2.4.9.新建分組接口91

2.4.10.修改分組接口93

2.4.11.刪除分組接口94

2.4.12.組信息查詢接口96

2.4.13.組內(nèi)設(shè)備信息查詢接口98

2.4.14.查詢用戶所有終端接口100

2.4.15.設(shè)備立即上報指令發(fā)送接口101

2.4.16.設(shè)備參數(shù)下送指令發(fā)送接口103

2.4.17.設(shè)備緊急上報指令發(fā)送接口104

2.4.18.設(shè)備搜索接口106

2.4.19.設(shè)備能力查詢接口108

2.4.20.設(shè)備關(guān)機(jī)請求接口109

2.5.任務(wù)管理接口111

2.5.1.任務(wù)參數(shù)查詢接口111

2.5.2.新增任務(wù)接口114

2.5.3.任務(wù)修改接口117

254.任務(wù)刪除接口120

2.5.5.任務(wù)列表查詢接口122

2.5.6.單個任務(wù)查詢接口124

2.5.7.任務(wù)設(shè)備查詢接口128

2.5.8.任務(wù)內(nèi)設(shè)備最近上報信息查詢接口130

2.5.9.任務(wù)開始接口133

2.5.10.任務(wù)結(jié)束接口135

2.5.11.任務(wù)報警數(shù)據(jù)匯總導(dǎo)出接口136

2.5.12.按月統(tǒng)計監(jiān)控賬號的任務(wù)數(shù)量137

2.5.13.新增任務(wù)模板接口138

2.5.14.修改任務(wù)模板接口140

2.5.15.刪除模板接口141

2.5.16.查詢?nèi)蝿?wù)模板列表接口142

2.5.17.查詢單個任務(wù)模板信息接口144

2.6.消息相關(guān)接口145

2.6.1.消息查詢接口145

2.6.2.消息設(shè)置已讀接口148

2.6.3.消息發(fā)送短信接口150

2.6.4.消息檢索接口151

第一章文檔說明

1.本文檔用于定義鯨物流保鏢產(chǎn)品面向WEB、APP及其它

相關(guān)產(chǎn)品的接口規(guī)范。

2.平臺的接口有以下約定：

(1)接口方式為HTTP

(2)方法支持GET和POST。

(3)所有接口的請求均有version信息，用于標(biāo)識接口版本

變化，如user/014ogin其中的01為版本號。

(4)所有接口的編碼方式采用UTF-8o

3.接口的URL形如〈接口路徑〉/cmd?name=＜命令名稱〉，其

中〈接口路徑〉對同一個接口發(fā)布環(huán)境下所有接口相同。建議接口

客戶端以參數(shù)形式配置(接口路徑〉，以利在測試和生產(chǎn)環(huán)境間切

換、接口發(fā)布信息變更等。(其中尖括號。括起的部分表示可變

部分)

4.接口路徑示例：

http://xxx:8119/service-api/wlx/user/01/login?userName=xx&pw

d=123

5.接口名稱、方法、數(shù)據(jù)的節(jié)點(diǎn)名和節(jié)點(diǎn)屬性名等區(qū)分大小

寫，必須嚴(yán)格按照本規(guī)范要求進(jìn)行處理。

6.統(tǒng)一接口測試地址：http://xxxxxx:xxxx/interface

第二章返值定義

接口錯誤提示代碼定義

代碼值說明

00成功

01錯誤

02沒有數(shù)據(jù)

2.1.公共接口

2.1.1.驗(yàn)證碼發(fā)送接口

A.接口功能

發(fā)送短信驗(yàn)證碼。

B.接口定義

命令名稱/wlx/valicode/01/send

Http方法Post/Get

提交參數(shù)

參數(shù)名類型長度可空標(biāo)志說明

phoneString11非空手機(jī)號

typeString1非空1注冊短信

2綁定短信

3解綁短信

4找回密碼

返回參數(shù)

參數(shù)名類型長度可空標(biāo)志說明

resultString2非空返回代碼

descriptionString非空描述

data,solidminuteString有效分鐘

返回值

類型含義

String(JSON)返回驗(yàn)證碼發(fā)送結(jié)果

返回值說明

〈樣例：

發(fā)送失敗

{"result":"01","description":"發(fā)送失敗"}

發(fā)送成功

(

"result":"00",

“description”:〃發(fā)送成功〃,

"data”:

〃solidminute〃：“30〃

2.1.2.驗(yàn)證碼驗(yàn)證接口

A.接口功能

檢驗(yàn)驗(yàn)證碼。

B.接口定義

命令名稱/wlx/valicode/01/check

Http方法Post/Get

提交參數(shù)

參數(shù)名類型長度可空標(biāo)志說明

phoneString11非空手機(jī)號

valicodeString非空短信驗(yàn)證碼

typeString非空1注冊短信

2綁定短信

3解綁短信

4找回密碼（需返

回用戶信息）

imgCodeString可空圖形驗(yàn)證碼

返回參數(shù)

參數(shù)名類型長度可空標(biāo)志說明

resultString2非空返回代碼

descriptionString非空描述

data,atString非空臨時會話token

返回值

類型含義

String(JSON)返回驗(yàn)證結(jié)果

返回值說明

〈樣例：

驗(yàn)證失敗

{"result":〃01","description":"驗(yàn)證碼已失效〃}

驗(yàn)證成功

{“result”:〃00〃，

“description”:〃驗(yàn)證成功〃，

"data"://type=4時返回

〃id〃：，Z2342GHJGYHWGG776789HGYHGTR5TR，Z,

“account”:〃wangsl〃，

“phone〃：，

"regTime":"2014-09-0908:00:00〃，

“photoUri":"http:〃xxxxx/xxx.jpg〃,

status:1,

〃at〃：〃29987987987FGADFASDGGSXXDF〃

2.1.3.圖片驗(yàn)證碼接口

A.接口功能

圖片驗(yàn)證碼獲取接口。

B.接口定義

命令名稱/wlx/valicode/01/img

Http方法Post/Get

提交參數(shù)

參數(shù)名類型長度可空標(biāo)志說明

phoneString32非空文件名

返回參數(shù)

參數(shù)名類型長度可空標(biāo)志說明

文件流

返回值

類型含義

pdfstream返回圖片流

返回值說明

〈無

2.1.4.圖片驗(yàn)證碼接口

A.接口功能

文件下載。

B.接口定義

命令名稱/wlx/files/01/download

Http方法Post/Get

提交參數(shù)

參數(shù)名類型長度可空標(biāo)志說明

無

返回參數(shù)

參數(shù)名類型長度可空標(biāo)志說明

圖片流

返回值

類型含義

imagestream返回圖片流

返回值說明

〈無

2.2.用戶管理接口

2.2.1.用戶名校驗(yàn)接口

A.接口功能

用戶名是否已注冊接口。

B.接口定義

命令名稱/wlx/user/01/namechk

Http方法Post/Get

提交參數(shù)

參數(shù)名類型長度可空標(biāo)志說明

usernameString6?35非空僅支持字母、數(shù)

字、下劃線三種

字符，6-35個字

符之間

返回參數(shù)

參數(shù)名類型長度可空標(biāo)志說明

resultString2非空

descriptionString非空描述

返回值

類型含義

String(JS0N)返回驗(yàn)證的結(jié)果

返回值說明

〈樣例：

用戶名已注冊

{“result"：“00“，"description"：”用戶名已注冊”]

用戶名未注冊

{“result"：“01“，"description":"用戶名未注冊”}

2.2.2.手機(jī)號是否已綁定接口

A.接口功能

手機(jī)號是否已綁定接口。

B.接口定義

命令名稱/wlx/user/01/phonechk

Http方法Post/Get

提交參數(shù)

參數(shù)名類型長度可空標(biāo)志說明

phoneString11非空手機(jī)號

返回參數(shù)

參數(shù)名類型長度可空標(biāo)志說明

resultString2非空

descriptionString非空描述

返回值

類型含義

String(JSON)返回驗(yàn)證的結(jié)果

返回值說明

〈樣例：

手機(jī)號已被綁定

{“result"：“00“，"description":"手機(jī)號已被綁定”}

手機(jī)號未綁定

{“result"：“01“，"description":"手機(jī)號未綁定”}

2.2.3.用戶注冊接口

A.接口功能

用戶注冊接口。

B.接口定義

命令名稱/wlx/user/01/register

Http方法Post/Get

提交參數(shù)

參數(shù)名類型長度可空標(biāo)志說明

accountString11非空用戶登錄名

phoneString11非空手機(jī)號

passwdString32非空密碼

valicodeString6非空驗(yàn)證碼

compNameString可空組織名稱

compAddrString可空組織地址

compTelString可空組織聯(lián)系電話

compLinkerNameString可空負(fù)責(zé)人姓名

compLinkerTelString可空負(fù)責(zé)人電話

compLinkerPhoneString可空負(fù)責(zé)人手機(jī)

compLinkerEmai1String可空負(fù)責(zé)人郵箱

返回參數(shù)

參數(shù)名類型長度可空標(biāo)志說明

resultString2非空返回代碼

descriptionString非空描述

data,idString非空用戶ID

data,accountString非空登錄帳號

data,phoneString非空綁定手機(jī)

data.regTimeString非空注冊時間

data.photoUriString非空頭像地址

data,statusString非空狀態(tài)

1有效0注銷

data,atString非空會話token

返回值

類型含義

String(JSON)返回驗(yàn)證的結(jié)果

返回值說明

〈樣例：

注冊成功

(

“result":"00",

"description":"注冊成功"，

〃data〃：

(

〃id〃：，Z2342GHJGYHWGG776789HGYHGTR5TR，Z,

“account”:〃wangsl〃，

“phone〃：，

"regTime":"2014-09-0908:00:00〃，

“photoUri":"http:〃xxxxx/xxx.jpg〃,

status:1,

〃at〃：〃29987987987FGADFASDGGSXXDF〃

手機(jī)號已被綁定

{"result":"01〃，"description”:〃該手機(jī)號已被綁定〃}

驗(yàn)證碼不正確

{“result〃：〃01〃，“description”:〃驗(yàn)證碼不正確〃}

2.2.4.用戶登錄驗(yàn)證接口

A.接口功能

用戶登錄驗(yàn)證接口。

B.接口定義

命令名稱/wlx/user/01/login

Http方法Post/Get

提交參數(shù)

參數(shù)名類型長度可空標(biāo)志說明

accountString非空登錄帳號（兼容

管理主賬戶和監(jiān)

控賬戶）

passwdString可空密碼

imgCodeString非空圖形驗(yàn)證碼

返回參數(shù)

參數(shù)名類型長度可空標(biāo)志說明

resultString2非空返回代碼

descriptionString非空描述

data,idString非空用戶ID

data,accountString非空登錄帳號

data,phoneString非空綁定手機(jī)

data.regTimeString非空注冊時間

data.photoUriString非空頭像地址

data,statusString非空狀態(tài)

1有效0注銷

data.userTypeString非空用戶類型

1管理賬戶0監(jiān)

控賬號

data,atString非空會話token

data.wechatOpenldString可空微信公眾號

data.alarmTypeString非空監(jiān)控賬號登陸時

有此報警類型

SMS通知

微信通知

SMS&微信通知

返回值

類型含義

String(JSON)返回驗(yàn)證的結(jié)果

返回值說明

〈樣例：

登錄成功

“result〃：〃00〃，

“description”:〃登錄成功〃，

"data”:

(

〃id〃：Z，2342GHJGYHWGG776789HGYHGTR5TRZ，,

“account”:〃wangsl〃，

“phone〃：，

，zregTimez，:"2014-09-0908:00:00〃，

“photoUri":"http:〃xxxxx/xxx.jpg〃，

status:1,

〃at〃：〃29987987987FGADFASDGGSXXDF〃

)

)

登錄失敗

{"result”:〃01〃，"description”:〃用戶名或密碼錯誤〃}

2.2.5.用戶信息修改接口

A.接口功能

用戶修改接口。

B.接口定義

命令名稱/wlx/user/01/update

Http方法Post/Get

提交參數(shù)

參數(shù)名類型長度可空標(biāo)志說明

uidString32非空用戶ID

compNameString可空組織名稱

compAddrString可空組織地址

compTelString可空組織聯(lián)系電話

compLinkerNameString可空負(fù)責(zé)人姓名

compLinkerTelString可空負(fù)責(zé)人電話

compLinkerPhoneString可空負(fù)責(zé)人手機(jī)

compLinkerEmai1String可空負(fù)責(zé)人郵箱

photoString可空頭像（Base64格

式）

atString非空用戶登錄token

返回參數(shù)

參數(shù)名類型長度可空標(biāo)志說明

resultString2非空返回代碼

descriptionString非空描述

data,idString非空用戶Id

data,accountString非空登錄帳號

data,phoneString非空綁定手機(jī)

data.regTimeString非空注冊時間

data.photoUriString非空頭像地址

data,statusString非空狀態(tài)

1有效0注銷

data.lastLoginTimeString非空最后登錄時間

data.compNameString可空組織名稱

data.compAddrString可空組織地址

data.compTelString可空組織聯(lián)系電話

data.compLinkerNameString可空負(fù)責(zé)人姓名

data.compLinkerTelString可空負(fù)責(zé)人電話

data.compLinkerPhoneString可空負(fù)責(zé)人手機(jī)

data.compLinkerEmai1String可空負(fù)責(zé)人郵箱

返回值

類型含義

String(JSON)返回驗(yàn)證的結(jié)果

返回值說明

〈樣例：

修改成功

{“result〃：〃00〃，“description”:〃修改成功”}

提交失敗

{"result":"01","description”:〃提交失敗“}

2.2.6.用戶密碼修改接口

A.接口功能

用戶修改密碼接口。

B.接口定義

命令名稱/wlx/user/01/chgpwd

Http方法Post/Get

提交參數(shù)

參數(shù)名類型長度可空標(biāo)志說明

uidString32非空用戶ID

passwdString非空密碼

oldpasswdString非空原密碼

atString非空會話token

返回參數(shù)

參數(shù)名類型長度可空標(biāo)志說明

resultString2非空返回代碼

descriptionString非空描述

data,atString非空新的會話token

返回值

類型含義

String(JSON)返回驗(yàn)證的結(jié)果

返回值說明

〈樣例：

修改成功

{"result":"00","description":"修改成功"，"data":{"at":"2345234SSFSDG234FF”}}

提交失敗

{"result":"01","description":"提交失敗"}

2.2.7.用戶重設(shè)密碼接口

A.接口功能

用戶重設(shè)密碼接口。

B.接口定義

命令名稱/wlx/user/01/resetpwd

Http方法Post/Get

提交參數(shù)

參數(shù)名類型長度可空標(biāo)志說明

uidString32非空用戶ID

passwdString非空密碼

atString非空臨時會話token

返回參數(shù)

參數(shù)名類型長度可空標(biāo)志說明

resultString2非空返回代碼

descriptionString非空描述

data,atString非空新的會話token

返回值

類型含義

String(JSON)返回驗(yàn)證的結(jié)果

返回值說明

〈樣例：

修改成功

{"result":"00","description":"修改成功"，"data":{"at":"2345234SSFSDG234FF”}}

提交失敗

{"result":"01","description":"提交失敗”}

2.2.8.用戶信息獲取接口

A.接口功能

用戶信息獲取接口。

B.接口定義

命令名稱/wlx/user/01/view

Http方法Post/Get

提交參數(shù)

參數(shù)名類型長度可空標(biāo)志說明

uidString32非空用戶id

typeString可空0僅返回用戶信

息，1返回用戶

及設(shè)置信息

為空時只取用戶

信息

atString非空用戶登錄token

返回參數(shù)

參數(shù)名類型長度可空標(biāo)志說明

resultString2非空返回代碼

descriptionString非空描述

data,accountString非空登錄帳號

data.userTypeString非空用戶類型

1管理賬戶0監(jiān)

控賬號

data,phoneString非空綁定手機(jī)

data.regTimeString非空注冊時間

data.photoUriString非空頭像地址

data,statusString非空狀態(tài)

1有效0注銷

data.lastLoginTimeString非空最后登錄時間

data.compNameString可空組織名稱

data.compAddrString可空組織地址

data.compTelString可空組織聯(lián)系電話

data.compLinkerNameString可空負(fù)責(zé)人姓名

data.compLinkerTelString可空負(fù)責(zé)人電話

data.compLinkerPhoneString可空負(fù)責(zé)人手機(jī)

data.compLinkerEmai1String可空負(fù)責(zé)人郵箱

data.wechatOpenldString可空微信公眾號

data.alarmTypeString非空監(jiān)控賬號信息查

詢時有此報警類

型

1.SMS通知

2.微信通知

3.SMS&微信通

知

data,pathsjson可空常用路徑信息

data,poisjson可空常用點(diǎn)位信息

data,groupsjson（id,名稱）可空分組信息

data,monitorsjson（id,名稱）可空監(jiān)控子賬號信息

data,tasksjson（id,名稱）可空任務(wù)信息信息

返回值

類型含義

String（JSON）返回驗(yàn)證的結(jié)果

返回值說明

〈樣例：

查詢成功

“result〃：〃00〃，

“description”:〃查詢成功”，

〃data〃：

(

〃id〃：“2342GHJGYHWGG776789HGYHGTR5TR〃，

“account”:〃wangsl〃，

“phone〃：，

"regTime":"2014-09-0908:00:00〃，

，/lastLoginTimez，:"2014-09-0908:00:00",

“photoUri":"http:〃xxxxx/xxx.jpg〃，

status:1

手機(jī)號已被綁定

{"result":"01〃，"description”:〃該手機(jī)號已被綁定〃}

驗(yàn)證碼不正確

{“result〃：〃01〃，“description”:〃驗(yàn)證碼不正確〃}

2.2.9.通過手機(jī)號獲取用戶信息接口

A.接口功能

通過手機(jī)號獲取用戶信息接口。

B.接口定義

命令名稱/wlx/user/01/viewbyphone

Http方法Post/Get

提交參數(shù)

參數(shù)名類型長度可空標(biāo)志說明

phoneString11非空用戶手機(jī)

返回參數(shù)

參數(shù)名類型長度可空標(biāo)志說明

resultString2非空返回代碼

descriptionString非空描述

data,idString非空用戶id

data,accountString非空登錄帳號

data,phoneString非空綁定手機(jī)

data.regTimeString非空注冊時間

data.photoUriString非空頭像地址

data,statusString非空狀態(tài)

1有效0注銷

返回值

類型含義

String(JSON)返回驗(yàn)證的結(jié)果

返回值說明

〈樣例：

查詢成功

{

"result":"00",

"description":"查詢成功”，

"data”:

{

"id":"2342GHJGYHWGG776789HGYHGTR5TR”,

account:wangs1,

“phone〃：，

"regTime":"2014-09-0908:00:00",

“photoUri":"http:〃xxxxx/xxx.jpg〃，

status:1

}

2.2.10.用戶手機(jī)號修改接口

A.接口功能

用戶修改綁定手機(jī)號接口。

B.接口定義

命令名稱/wlx/user/01/chgphone

Http方法Post/Get

提交參數(shù)

參數(shù)名類型長度可空標(biāo)志說明

uidString32非空用戶ID

phoneString非空新手機(jī)號

valicodeString非空驗(yàn)證碼

atString非空會話token

返回參數(shù)

參數(shù)名類型長度可空標(biāo)志說明

resultString2非空返回代碼

descriptionString非空描述

返回值

類型含義

String(JSON)返回驗(yàn)證的結(jié)果

返回值說明

〈樣例：

修改成功

{"result":"00","description":"修改成功"}

提交失敗

{"result":"01","description":"提交失敗"}

2.2.11.用戶頭像上傳接口

A.接口功能

更換用戶頭像接口。

B.接口定義

命令名稱/wlx/user/01/chgphoto

Http方法Post/Get

提交參數(shù)

參數(shù)名類型長度可空標(biāo)志說明

uidString32非空用戶ID

atString非空會話token

photoString

返回參數(shù)

參數(shù)名類型長度可空標(biāo)志說明

resultString2非空返回代碼

descriptionString非空描述

data.photoUriString非空頭像鏈接

返回值

類型含義

String(JSON)返回驗(yàn)證的結(jié)果

返回值說明

〈樣例：

修改成功

{“result":"00","description":"修改成功

","data":{"photoUri":"http:〃xxxx/sss.jpg”}}

提交失敗

{"result":"01","description":"提交失敗"}

2.2.12.新增監(jiān)控賬號接口

A.接口功能

新增監(jiān)控賬號接口（登錄密碼與監(jiān)控手機(jī)不能都空）。

B.接口