本文檔介紹了如何通過API的方式使用ID2(適用于新加坡region)將設備接入到阿里云物聯網平臺。
一、準備工作
1、申請阿里云賬號
如果您已經擁有阿里云賬號,請忽略。如果您還沒有阿里云賬號,請先申請賬號。
2、獲取AccessKey
請查看如何獲取AccessKey:http://m.bestwisewords.com/document_detail/53045.html
注意:如果采用子賬號AccessKey,需要為子賬號添加iot和iotid產品訪問RAM權限。
為RAM用戶授權:http://m.bestwisewords.com/document_detail/116146.html
3、準備開發環境
您需要準備一臺PC或者服務器,安裝Java v1.8及以上的版本。
4、開通阿里云物聯網平臺
登錄阿里云物聯網平臺控制臺地址:https://iot.console.aliyun.com,并切換region為:新加坡。
在這個步驟里不要創建產品。
5、下載ID2接入示例代碼工程
下載ID2 OpenAPI接入的Java示例代碼工程:id2-openapi-docking.zip。點擊立即下載
該工程代碼展示了如何基于阿里云物聯網平臺、阿里云設備身份認證(ID2)的SDK調用OpenAPI,完成創建產品、查看產品列表、查看產品的ID2授權等操作,從而通過API的方式實現用戶在控制臺的常用操作。
二、接入流程
1、開通權限
請您聯系ID2產品小二開通新加坡(region)產品使用權限。
2、創建產品
進入任一實例后,進入 設備管理-產品 頁面,點擊 創建產品 按鈕,選擇認證方式為“ID2”。
創建完成后,運行調用示例代碼:B_ID2_ListCustomerProducts(需要替換您的阿里云賬號AccessKeyID和AccessKeySecret),查看ID2(新加坡)產品列表,也可以看到新創建的產品。
3、購買授權
請您聯系ID2產品小二購買新加坡(region)的ID2授權,需要提供以下信息:
阿里云賬號ID
產品的ProductKey
需要購買的ID2授權年限(1年、3年、5年)
需要購買的ID2授權數量
獲取阿里云賬號ID :登錄控制臺,點擊右上角的 賬號名/頭像,獲取 賬號ID。
購買完授權后,可以通過調用示例代碼:C_ID2_QueryId2OrderInfo,查看對應產品的授權總量、用量。
5、設備集成
建議您在國內(上海region)IoT安全中心控制臺,自行完成設備端集成對接工作。
參考最佳實踐:http://m.bestwisewords.com/document_detail/209777.html
6、設備接入新加坡服務端
通過修改設備端配置,將設備切換到新加坡region的服務端
設備在國內(上海region)完成端到端調試后,通過修改接入點、產品信息就可以接入到新加坡Region。
新加坡region接入點:${ProductKey}.itls.ap-southeast-1.aliyuncs.com
修改產品配置:ProductKey、ProductSecret
其中,ProductKey和ProductSecret可以登錄阿里云物聯網平臺(新加坡region)控制臺,進入產品詳情頁查看。
參考材料:
1、OpenAPI示例代碼工程
2、物聯網平臺接口(CreateProduct)說明
https://next.api.aliyun.com/api/Iot/2018-01-20/CreateProduct?tab=DOC
2、ID2相關API說明
ListCustomerProducts
接口名稱:ListCustomerProducts
功能描述:獲取產品列表
輸入參數:
名稱 | 類型 | 是否必須 | 描述 |
ProductName | String | 否 | 產品名稱 |
CurrentPage | Integer | 是 | 當前頁,從1開始 |
PageSize | Integer | 是 | 分頁大小,不超過30 |
輸出參數:
名稱 | 類型 | 描述 |
RequestId | String | 請求ID |
Success | boolean | true – 成功,false – 失敗 |
Code | String | 錯誤碼,見下文定義 |
ErrorMessage | String | 錯誤信息 |
TotalCount | Integer | 總個數 |
CurrentPage | Integer | 當前頁 |
Data | List<ProductList> | 數據域 |
ProductList字段描述 | ||
ProductName | String | 產品名稱 |
ProductKey | String | ProductKey |
ProductSource | Integer | 產品來源 |
GmtCreate | String | 產品創建時間 |
QueryId2OrderInfo
接口名稱:QueryId2OrderInfo
功能描述:獲取指定產品的ID2使用授權信息
輸入參數:
名稱 | 類型 | 是否必須 | 描述 |
ProductKey | String | 是 | ProductKey |
ProductSource | Integer | 是 | 產品來源 |
輸出參數:
名稱 | 類型 | 描述 |
RequestId | String | 請求ID |
Success | boolean | true – 成功,false – 失敗 |
Code | String | 錯誤碼,見下文定義 |
ErrorMessage | String | 錯誤信息 |
Data | List<Id2OrderInfo> | 數據域,列表按授權有效期分組 |
Id2OrderInfo字段描述 | ||
ValidateTimeType | Integer | 授權有效期: 0-5年, 1-3年, 2-1年 |
TotalAmount | Integer | 授權總量 |
UsedAmount | Integer | 已激活量 |
OtpUsedAmount | Integer | 已空發量 |