相關文檔

>> GServer實時接口(JSON)示例說明

 

GServer實時接口(JSON)說明：

本規范規定了直接接入EXLIVE平臺GServer應用服務器的接口定義，采用TCP通訊方式，實現了用戶登錄、權限驗證、各種數據傳輸等功能。

本規范主要用來實現第三方軟件和GServer服務器實時互通，采用TCP傳輸方式，端口為1502，數據格式使用json格式。

數據分為數據頭(header)和數據體(body)兩個部分。

數據頭(header)部分格式為：

"header":
{
"cmd":"1000"
}

格式主要包含一個命令字(cmd)屬性，程序根據命令字來區分數據體的內容。數據體(body)部分包含的數據會根據數據頭中的命令字(cmd)而異。

 

 

第三方平臺數據轉入EXLIVE平臺步驟：

>> 獲取一個EXLIVE平臺帳號

>> 以TCP方式登錄EXLIVE平臺1502端口，參考用戶登錄命令1000

>> 等待exlive平臺登錄返回成功，如果返回結果不是success服務器將掐斷TCP連接

>> 收到成功后，第三方平臺需要間隔30秒發送心跳消息，參看客戶端心跳　1002

>> 連接成功后，第三方平臺可以按照　車輛定位數據 1007　格式上傳車輛數據

>> 第三方平臺退出連接可以發送　用戶退出 1001命令，然后斷開TCP連接

 

自己開發客戶端接入EXLIVE平臺GServer服務器步驟：

>> 獲取一個EXLIVE平臺帳號
>> 以TCP方式登錄EXLIVE平臺1502端口，參考用戶登錄命令1000
>> 等待exlive平臺登錄返回成功，如果返回結果不是success服務器將掐斷TCP連接
>> 收到成功后，第三方平臺需要間隔30秒發送心跳消息，參看客戶端心跳　1002
>>請求下發用戶下客戶和分組數據 1008
>>請求下發每個分組下的車輛數據　1010
>> 服務器向客戶端轉發車輛的實時定位數據　1007
>>客戶端向車載終端下發車機命令　1003
>> 客戶端退出連接，發送退出命令 1001，然后斷開TCP連接

 

 

1.用戶從客戶端登錄GServer服務器

數據發送方向：client —> server

命令字：1000

參數

參數	類型	說明
name	String	用戶名稱
pass	String	用戶密碼
ver	String	客戶端版本，如 4.6936
type	String	客戶端類型　json_common
mode	String	備用，填空

格式：

{
　"header":
　{
　　"cmd":"1000"
　},
　"body":
　{
　　"name":"exlive",
　　"pass":"000000",
　　"ver":"4.6936",
　　"type":"json_common",
　　"mode":""
　}
}

 

 

 

2.服務器對客戶端發送命令返回的通用應答

數據發送方向：server —> client

命令字：8000

參數：

參數	類型	說明
cmd	String	服務器接收到的命令字
result	String	結果success　成功　failed失敗

格式：

{
　"header":
　{
　　"cmd":"8000"
　},
　"body":
　{
　　"cmd":"1000",
　　"result":"success"
　}
}

 

 

3.用戶從客戶端退出/注銷登錄

數據發送方向：client —> server

命令字：1001

參數：

參數	類型	說明
data	String	空

格式：

{
　"header":
　{
　　"cmd":"1001"
　},
　"body":
　{
　　"data":""
　}
}

 

 

4.客戶端向服務器發送心跳消息

數據發送方向：client —> server

命令字：1002

客戶端登錄成功后，需要按照30秒間隔向服務器發送心跳消息，如果3分鐘沒有收到客戶端發送的心跳消息，服務器端將主動斷開客戶端的連接

參數：

參數	類型	說明
result	String	空

格式：

{
　"header":
　{
　　"cmd":"1002"
　},
　"body":
　{
　　"result":""
　}
}

 

 

5.服務器向客戶端發送通知消息

數據發送方向：client <—> server

命令字：1003

參數：

參數	類型	說明
msg	String	消息內容

格式：

{
　"header":
　{
　　"cmd":"1003"
　},
　"body":
　{
　　"msg":""
　}
}

 

 

6.客戶端向車載終端發送車機命令

數據發送方向：client —> server

命令字：1004

參數：

參數	類型	說明
terminalid	String	設備id
code	String	車牌號碼
cmdid	String	命令id
cmdpass	String	命令密碼

格式：

{
　"header":
　{
　　"cmd":"1004"
　},
　"body":
　{
　　"terminalid":"",
　　"code":"",
　　"cmdid":"7004",
　　"cmdpass":"",
　　"data":"<cmd><id>7000</id><param>上報間隔</param><para>上報次數</param><param>命令密碼</param></cmd>"
　}
}

 

 

7.服務器向客戶端轉發車輛實時定位數據

數據發送方向：server —> client

命令字：1007

參數：

參數	類型	說明
code	String	車牌號碼
id	String	車輛ID
lat	String	緯度
lng	String	經度
veo	String	速度
dir	String	方向
gpstime	String	格式為：2011-11-01 12:38:39
av	String	表示是否為有效定位， 0 無效定位， 1有效定位
alarm	String	是否報警， 0 無報警， 1 報警
oil	String	當前油量
dis	String	當前總里程
wstate	String	整數類型狀態
cstate	String	狀態描述，可以為空
posinfo	String	位置描述，可以為空
p1	String	模擬量1
p2	String	模擬量2
temp	float	溫度
temp0	float	溫度1
temp1	float	溫度2
temp2	float	溫度3
temp3	float	溫度4

格式：

{
　"header":
　{
　　"cmd":"1007"
　},
　"body":
　{
　　"code":"",
　　"id":"",
　　"lat":"",
　　"lng":"",
　　"veo":"",
　　"dir":"",
　　"gpstime":"",
　　"av":"",
　　"alarm":"",
　　"oil":"",
　　"dis":"",
　　"wstate":"",
　　"cstate":"",
　　"posinfo":"",
　　"p1":"",
　　"p2":"",
       "temp":,
       "temp0":,
       "temp1":,
       "temp2":,
       "temp3":
　}
}

 

 

 

8.客戶端請求服務器下發用戶權限下客戶及分組數據

數據發送方向：client —> server

命令字：1008

參數：

參數	類型	說明
client	String	true 下發客戶關系數據，false 不下發

格式：

{
　"header":
　{
　　"cmd":"1008"
　},
　"body":
　{
　　"client":"true"
　}
}

 

 

9.服務器向客戶端下發用戶的客戶、分組數據

數據發送方向：client —> server

命令字：1009

參數：

參數	類型	說明
groupid	String	車輛分組的ID
relation	String	用戶的客戶
customer	String	分組的客戶
goupname	String	分組名稱

格式：

{
　"header":
　{
　　"cmd":"1009"
　},
　"body":
　{
　　"groupid":"",
　　"relation":"",
　　"customer":"",
　　"goupname":""
　}
}

 

 

10.客戶端請求服務器下發用戶權限下分組的車輛數據

數據發送方向：client —> server

命令字：1010

參數：

參數	類型	說明
groupid	String	車輛分組ID

格式：

{
　"header":
　{
　　"cmd":"1010"
　},
　"body":
　{
　　"groupid":"1"
　}
}

 

 

11.服務器向客戶端下發用戶權限下指定分組的車輛靜態數據

數據發送方向：server —> client

命令字：1011

參數：

參數	類型	說明
id	String	車輛ID
code	String	車牌號碼
sim	String	SIM卡號碼
terminalid	String	終端設備ID
groupname	String	車輛所屬分組名稱
vhctype	String	車輛類型
mobiletype	String	終端設備類型

格式：

{
　"header":
　{
　　"cmd":"1011"
　},
　"body":
　{
　　"id":"",
　　"code":"",
　　"sim":"",
　　"terminalid":"",
　　"groupname":"",
　　"vhctype":"",
　　"mobiletype":""
　}
}

 

 

12.客戶端發送車機透傳命令到設備

數據發送方向：client —> server

命令字：1012

參數：

參數	類型	說明
terminalid	String	設備ID
code	String	車牌號碼
cmdid	String	命令ID, 透傳命令固定為7513
cmdpass	String	透傳命令密碼,一般為空
data	String	透傳數據的16進制字符串

格式：

{
　"header":
　{
　　"cmd":"1012"
　},
　"body":
　{
　　"terminalid":"",
　　"code":"",
　　"cmdid":"",　
　　"cmdpass":"",
　　"data":""
　}
}

 

 

13.服務器轉發車載終端的透傳數據到客戶端

數據發送方向：server —> client

命令字：1013

參數：

參數	類型	說明
terminalid	String	設備
code	String	車牌號碼
data	String	透傳數據的16進制字符串

格式：

{
　"header":
　{
　　"cmd":"1013"
　},
　"body":
　{
　　"terminalid":"",
　　"code":"",
　　"data":""
　}
}