国产精品精品视频_日韩毛片在线免费观看_国产强伦姧在线观看无码_乱伦影视综合国产_欧美三级特黄在线_日本我不卡中文字幕_国产 抽搐 喷水 在线_日本一区免费观看_色爱无码av综合区_88人妻丰满熟妇Aⅴ无码

物聯(lián)網(wǎng)智慧云平臺能力調(diào)用參考文檔

文檔版本 V1.0.0

版本說明

版本號 更新時間 更新人 主要內(nèi)容或重大修改
v1.0.0 2021-05-27

新增接口：

查詢卡片狀態(tài)

查詢卡片用量

查詢所屬群組信息

查詢規(guī)定群組數(shù)據(jù)

停復(fù)機

錯誤碼

錯誤碼 說明
0 正確
500 內(nèi)部錯誤，請聯(lián)系管理員
11000 請求參數(shù)錯誤，請參考能力調(diào)用文檔
12004 transId 或 appid 或 token 鑒權(quán)失敗
12009 卡號鑒權(quán)失敗，不屬于此用戶
12010 卡號鑒權(quán)失敗，不存在本系統(tǒng)
12021 token 過期，重新獲取的 token 會立馬更新
443 客戶端錯誤: 無效的appid
12022 appid 或 password 鑒權(quán)不通過
12034 群組 ID 不屬于本企業(yè)
446 客戶端錯誤: 未設(shè)置時間戳
12089 該卡片不是待激活、已激活、已停機，無法進行操作
12098 當(dāng)前停機原因不符合自主發(fā)起復(fù)機操作要求,只有主動申請停機的 才允許自主復(fù)機
12099 卡片主套餐超出有效期，無法復(fù)機
12100 卡片所屬套餐的用量已達量
12010 卡片所屬流量池可用量已達量
19010 其他錯誤，聯(lián)系管理員

1. 認證接口

1.1 認證服務(wù)接口

token（令牌）獲取接口

1.1.1 認證服務(wù)接口

服務(wù)地址 :

http://sz.cotonda.com/iotManage/api/getToken

業(yè)務(wù)描述：

集團客戶從自服務(wù)平臺獲取 appid 和 password 進行認證服務(wù)校驗，成功則返回鑒權(quán)標識 token。該接口 用于用戶獲取 token，客戶和 OneLink 能力開放平臺同 時緩存該 token，token 過期則平臺返回錯誤 碼，用戶重新調(diào)用 token 獲取接口獲 取 token，token 過期時間為 2 小時。OneLink 能力開放平臺業(yè) 務(wù)接口需要對 token 校驗，校驗通過則完成身份驗證。

請求參數(shù)說明

參數(shù) 是否必須 類型 含義
appid 是 String 應(yīng)用編碼，第三方應(yīng)用唯一標識。由物聯(lián)集 團客戶向科通達提出 API 接入申請，科通達 物聯(lián)網(wǎng)全網(wǎng)管理員在 物聯(lián)云網(wǎng)智慧云平臺 能力開放 平臺上分配并展示給集團戶， appid 樣例：202105242146195403
password 是 String API 接入秘鑰，由科通達物聯(lián)網(wǎng)提供，集團 客戶從自服務(wù)平臺獲?。ㄎ锫?lián)云網(wǎng)智慧云 平 臺上 API 使用說明下），token 過期時間暫 定為 2 小時。
timeStamp 是 String 時間戳 yyyyMMddHHmmss+10 個隨機數(shù)

URL :

http://sz.cotonda.com/iotManage/api/getToken?appid=xxxx&password=xxxx&timeStamp=xxxx
返回參數(shù)說明
參數(shù) 是否必須 默認值 含義
success 是 boolean 請求是否成功。true - 成功 false - 失敗
errorCode 是 int 錯誤碼。0-成功 非 0-失敗
errorMsg 是 String 時間戳 yyyyMMddHHmmss+10 個隨機數(shù)
data 是 Object 返回結(jié)果集（errorCode 為“0”時，data 包 含正確的結(jié)果數(shù)據(jù)；errorCode 為“非 0”時， data 為空） 此處為 token 的值，需要保存起 來，一小時后過期

返回報文舉例

成功： 
{
"success": true， 
"errorCode": 0， 
"errorMsg": "", 
"data": "token": "d362fc0cfe91e3b1263abec0b44869d8065f3b8cbe974b8805bfa7b4435b83da" 
}
失敗： {
"success": flase， 
"errorMsg":"PASSWORD 鑒權(quán)不通過", 
"data":{}, 
"errorCode":12022 
}

2. 物聯(lián)卡管理類

2.1 復(fù)機

服務(wù)地址：

http://sz.cotonda.com/iotManage/api/activationCard

業(yè)務(wù)描述：

集團客戶可以通過卡號 iccid 變更集團歸屬物聯(lián)卡的狀態(tài)（同一卡號 3 分鐘內(nèi) 不能通過此類接口重復(fù)辦理業(yè)務(wù)）。

請求參數(shù)說明：

參數(shù) 是否必填 類型 含義
transId 是 String 事務(wù)編碼，由物聯(lián)卡集團客戶按照相應(yīng)規(guī)則自 主生成，生成規(guī)則：yyyyMMddHHmmss+APPID+ 八 位 隨 機 數(shù) ， appid 樣 例 ： 2021051317190020210430105318808600000000
token 是 String 令牌，通過指定接口獲取。
iccid 是 String 集成電路卡識別碼，IC 卡的唯一識別號碼，共 有 20 位字符組成，舉例：898600D6991330004146

URL:

http://sz.cotonda.com/iotManage/api/activationCard?transId=xxxx&token=xxxx&icci d=xxxx

返回參數(shù)說明：

參數(shù) 是否必須 默認值 含義
suceess 是 boolean 請求是否成功。true - 成功 false - 失敗
errorCode 是 int 錯誤碼。0-成功 非 0-失敗
errorMsg 是 String 時間戳 yyyyMMddHHmmss+10 個隨機數(shù)
data 是 Object 返回結(jié)果集（errorCode 為“0”時，data 包 含正確的結(jié)果數(shù)據(jù)；errorCode 為“非 0”時， data 為空） 此處為 iccid 的值

返回報文舉例

成功：
 {
"success": true， 
"errorCode": 0， 
"errorMsg": "", 
"data": "898600D6991330004146" 
}
失敗： {
"success": flase， 
"errorMsg":"TOKEN 不存在或已過期，請重新獲取", 
"data":{}, 
"errorCode":12022 
}

2.2 停機

服務(wù)地址：

http://sz.cotonda.com/iotManage/api/stopCard

業(yè)務(wù)描述：

集團客戶可以通過卡號 iccid 變更集團歸屬物聯(lián)卡的狀態(tài)

請求參數(shù)說明:

參數(shù) 是否必須 類型 含義
transId 是 String 事務(wù)編碼，由物聯(lián)卡集團客戶按照相應(yīng)規(guī)則自 主生成，生成規(guī)則：yyyyMMddHHmmss+APPID+ 八 位 隨 機 數(shù) ， appid 樣 例 ： 2021051317190020210430105318808600000000
token 是 String 令牌，通過指定接口獲取。
iccid 是 String 集成電路卡識別碼，IC 卡的唯一識別號碼，共 有 20 位字符組成，舉例：898600D6991330004146

URL:

http://sz.cotonda.com/iotManage/api/stopCard?transId=xxxx&token=xxxx&iccid=xxxx

返回參數(shù)說明：

參數(shù) 是否必須 默認值 含義
suceess 是 boolean 請求是否成功。true - 成功 false - 失敗
errorCode 是 int 錯誤碼。0-成功 非 0-失敗
errorMsg 是 String 時間戳 yyyyMMddHHmmss+10 個隨機數(shù)
data 是 Object 返回結(jié)果集（errorCode 為“0”時，data 包 含正確的結(jié)果數(shù)據(jù)；errorCode 為“非 0”時， data 為空） 此處為 iccid 的值

返回報文舉例

成功： 
{
"success": true， 
"errorCode": 0， 
"errorMsg": "", 
"data": "898600D6991330004146" 
}
失?。?{
"success": flase， 
"errorMsg":"TOKEN 不存在或已過期，請重新獲取", 
"data":{}, 
"errorCode":12022 
}

3. 物聯(lián)卡查詢類

3.1 查詢卡狀態(tài)

服務(wù)地址：

http://sz.cotonda.com/iotManage/api/getCardStatus

業(yè)務(wù)描述：

集團客戶可以通過卡號 iccid 查詢集團歸屬物聯(lián)卡的狀態(tài)

請求參數(shù)說明：

參數(shù) 是否必須 類型 含義
transId 是 String 事務(wù)編碼，由物聯(lián)卡集團客戶按照相應(yīng)規(guī)則自 主生成，生成規(guī)則：yyyyMMddHHmmss+APPID+ 八 位 隨 機 數(shù) ， appid 樣 例 ： 2021051317190020210430105318808600000000
token 是 String 令牌，通過指定接口獲取。
iccid 是 String 集成電路卡識別碼，IC 卡的唯一識別號碼，共 有 20 位字符組成，舉例：898600D6991330004146

URL:

http://sz.cotonda.com/iotManage/api/getCardStatus?transId=xxxx&token=xxxx&icci d=xxxx

返回參數(shù)說明：

參數(shù) 是否必須 默認值 父級 含義
suceess 是 boolean 無 請求是否成功。true - 成功 false - 失 敗
errorCode 是 int 無 錯誤碼。0-成功 非 0-失敗
errorMsg 是 String 無 時間戳 yyyyMMddHHmmss+10 個隨機數(shù)
data 是 Object 無 返回結(jié)果集（errorCode 為“0”時，data 包含正確的結(jié)果數(shù)據(jù)；errorCode 為“非 0”時， data 為空）
activateTime 是 String data 第一次激活時間
status 是 int data 卡片狀態(tài)（1：待激活 2：已激活 3：已停機 4：已失效 5：測試卡 6：已銷戶 7：庫存 ）
iccid 是 String data iccid

返回報文舉例

成功： 
{ 
"data": { 
"activateTime": "2020-10-24 11:37", 第一次激活的時間 
"cardStatus": 2, 
"iccId": "898600D6991330004146" 
}, 
"errorCode": 0, 
"errorMsg": "", 
"success": true 
}
失敗： {
"success": flase， 
"errorMsg":"TOKEN 不存在或已過期，請重新獲取", 
"data":{}, 
"errorCode":12022 
}

3.2 查詢卡用量

服務(wù)地址：

http://sz.cotonda.com/iotManage/api/getCardDosage

業(yè)務(wù)描述：

集團客戶可以通過卡號 iccid 查詢集團歸屬物聯(lián)卡的狀態(tài)

請求參數(shù)說明:

參數(shù) 是否必須 類型 含義
transId 是 String 事務(wù)編碼，由物聯(lián)卡集團客戶按照相應(yīng)規(guī)則自 主生成，生成規(guī)則：yyyyMMddHHmmss+APPID+ 八 位 隨 機 數(shù) ， appid 樣 例 ：2021051317190020210430105318808600000000
token 是 String 令牌，通過指定接口獲取。
iccid 是 String 集成電路卡識別碼，IC 卡的唯一識別號碼，共 有 20 位字符組成，舉例：898600D6991330004146

URL:

http://sz.cotonda.com/iotManage/api/getCardStatus?transId=xxxx&token=xxxx&icci d=xxxx

返回參數(shù)說明：

參數(shù) 是否必須 默認值 父級 含義
suceess 是 boolean 無 請求是否成功。true - 成功 false - 失 敗
errorCode 是 int 無 錯誤碼。0-成功 非 0-失敗
errorMsg 是 String 無 時間戳 yyyyMMddHHmmss+10 個隨機數(shù)
data 是 Object 無 返回結(jié)果集（errorCode 為“0”時，data 包含正確的結(jié)果數(shù)據(jù)；errorCode 為“非 0”時， data 為空）
updateTime 是 String data 最近更新時間
dosage 是 double data 卡片用量
iccid 是 String data iccid

返回報文舉例

成功： 
{ 
"data": { 
"dosage": 0, 
"updateTime": "2021-05-11 18:15" 
}, 
"errorCode": 0,
"errorMsg": "卡片狀態(tài)為 1", 
"success": true 
}
失?。?
{
"success": flase，
 "errorMsg":"TOKEN 不存在或已過期，請重新獲取", 
 "data":{}, 
 "errorCode":12022 
 }

3.3 查詢?nèi)航M信息

服務(wù)地址：

http://sz.cotonda.com/iotManage/api/getCardDosage

業(yè)務(wù)描述：

集團客戶可以通過卡號 iccid 查詢集團歸屬物聯(lián)卡的狀態(tài)

請求參數(shù)說明:

參數(shù) 是否必須 類型 含義
transId 是 String 事務(wù)編碼，由物聯(lián)卡集團客戶按照相應(yīng)規(guī)則自 主生成，生成規(guī)則：yyyyMMddHHmmss+APPID+ 八 位 隨 機 數(shù) ， appid 樣 例 ：2021051317190020210430105318808600000000
token 是 String 令牌，通過指定接口獲取。

URL:

:http://sz.cotonda.com/iotManage/api/queryGroupInfo?transId=xxxx&token=xxxx

返回參數(shù)說明：

參數(shù) 是否必須 默認值 父級 含義
suceess 是 boolean 無 請求是否成功。true - 成功 false - 失 敗
errorCode 是 int 無 錯誤碼。0-成功 非 0-失敗
errorMsg 是 String 無 時間戳 yyyyMMddHHmmss+10 個隨機數(shù)
data 是 Object 無 返回結(jié)果集（errorCode 為“0”時，data 包含正確的結(jié)果數(shù)據(jù)；errorCode 為“非 0”時， data 為空）
name 是 String data 群組名稱
flowPoolId 是 String data 群組 id

返回報文舉例

成功： 
{ 
"data": [ 
{ 
"name": "流量池 30G", 
"flowPoolId": "splitNum00014508" 
} 
],
"errorCode": 0, 
"errorMsg": "", 
"success": true 
}
失?。?
{
"success": flase， 
"errorMsg":"TOKEN 不存在或已過期，請重新獲取", 
"data":{}, 
"errorCode":12022
 }

3.4 查詢?nèi)航M信息

服務(wù)地址：

http://sz.cotonda.com/iotManage/api/getCardDosage

業(yè)務(wù)描述：

集團客戶可以通過卡號 iccid 查詢集團歸屬物聯(lián)卡的狀態(tài)

請求參數(shù)說明:

參數(shù) 是否必須 類型 含義
transId 是 String 事務(wù)編碼，由物聯(lián)卡集團客戶按照相應(yīng)規(guī)則自 主生成，生成規(guī)則：yyyyMMddHHmmss+APPID+ 八 位 隨 機 數(shù) ， appid 樣 例 ：2021051317190020210430105318808600000000
token 是 String 令牌，通過指定接口獲取。
flowPoolId 是 String 群組 id

URL:

http://sz.cotonda.com/iotManage/api/stopCard?queryGroupData=xxxx&token=xxxx& flowPoolId=xxxx

返回參數(shù)說明：

參數(shù) 是否必須 默認值 父級 含義
suceess 是 boolean 無 請求是否成功。true - 成功 false - 失 敗
errorCode 是 int 無 錯誤碼。0-成功 非 0-失敗
errorMsg 是 String 無 時間戳 yyyyMMddHHmmss+10 個隨機數(shù)
data 是 Object 無 返回結(jié)果集（errorCode 為“0”時，data 包含正確的結(jié)果數(shù)據(jù)；errorCode 為“非 0”時， data 為空）
name 是 String data 群組名稱
flowPoolId 是 String data 群組 id
quantity 是 int data 總卡數(shù)
activateNum 是 int data 激活卡數(shù)
stopNum 是 int data 停機卡數(shù)
totalFlow 是 double data 可用總流量
dosage 是 double data 已用量
surplus 是 double data 剩余量
numberSements 是 List data 包含流量池的所屬號段
startIccId 是 String numberSements 某一號段開始的 iccId
endIccId 是 String numberSements 某一號段結(jié)束的 iccId

返回報文舉例

成功： 
{ 
"data": { 
"activateNum": 13, 
"dosage": 503, 
"flowPoolId": "splitNum00004508", 
"name": "流量池 30G", 
"numberSegments": [ 
{ 
"endIccId": "898604801920C0200004", 
"startIccId": "898604801920C0200000" 
},
{ "endIccId": "898604801920C0200010", 
"startIccId": "898604801920C0200005" 
},
{ 
"endIccId": "898604801920C0200024",
 "startIccId": "898604801920C0200013" 
 },
 { 
 "endIccId": "898604801920C0200012", 
 "startIccId": "898604801920C0200011" 
 } 
 ],
 "quantity": 25,
  "stopNum": 4, 
  "surplus": 7, 
  "totalFlow": 510
   },
   "errorCode": 0,
   "errorMsg": "", 
   "success": true
    }
失?。?
{
"success": flase， 
"errorMsg":"TOKEN 不存在或已過期，請重新獲取", 
"data":{}, 
"errorCode":12022

 }