調用生活物聯(lián)網(wǎng)平臺API時，您需要了解API的公共信息，包括網(wǎng)關協(xié)議與地址、調用方法、請求參數(shù)、返回參數(shù)等。
調用客戶端API與調用云端API需要使用不同的AppKey和AppSecret來進行身份認證和鑒權。AppKey和AppSecret由生活物聯(lián)網(wǎng)平臺頒發(fā)，獲取方式如下。
App端：您需要從平臺獲取AppKey和AppSecret，詳細操作請參見創(chuàng)建自有App。
云端：您需要從平臺獲取AppKey和AppSecret，詳細操作請參見獲取云端Appkey。
API網(wǎng)關協(xié)議與地址
當您發(fā)送請求調用API時，API網(wǎng)關會校驗含有AppSecret的簽名。如果校驗不通過，則會丟棄請求并返回401錯誤碼。其中，API網(wǎng)關的協(xié)議為HTTPS，網(wǎng)關地址如下。
數(shù)據(jù)中心 | Region ID | 網(wǎng)關地址 |
華東2（上海） | cn-shanghai | api.link.aliyun.com |
新加坡 | ap-southeast-1 | ap-southeast-1.api-iot.aliyuncs.com |
德國（法蘭克福） | eu-central-1 | eu-central-1.api-iot.aliyuncs.com |
美國（弗吉尼亞） | us-east-1 | us-east-1.api-iot.aliyuncs.com |
如何調用API
生活物聯(lián)網(wǎng)平臺提供了App端API和云端API，并為您提供了以下語言API的調用SDK或調用示例。
端側 | 支持的語言種類 | 調用SDK或調用示例 |
App端 |
| |
云端 |
|
如果您需要使用別的語言來調用API，則需要自行實現(xiàn)該語言的加簽邏輯，請參見加簽機制。
公共請求參數(shù)
生活物聯(lián)網(wǎng)平臺提供的所有API都遵循一致的入?yún)⒁?guī)范，其中如下字段為接口調用必須傳入的公共字段。
參數(shù) | 子參數(shù) | 類型 | 必有 | 描述 |
id | - | String | 是 | 請求ID，如使用生活物聯(lián)網(wǎng)平臺提供的SDK，則會自動生成；如果您自行調用API，則需要自己生成。該參數(shù)主要用于關聯(lián)請求應答及問題定位。 |
version | - | String | 是 | 開放平臺的版本號，當前固定為 |
request | - | - | 是 | 系統(tǒng)請求參數(shù)。 |
- | apiVer | String | 是 | 所調用接口對應的版本號，具體參見相應的接口文檔。 |
- | iotToken | String | 是 | 該參數(shù)僅調用客戶端API時生效，主要用于確認請求發(fā)起者的系統(tǒng)參數(shù)，使用生活物聯(lián)網(wǎng)平臺提供的賬號SDK時該值會自動生成。 |
- | cloudToken | String | 是 | 該參數(shù)僅調用云端API時生效，需要您使用項目ID自行獲取對應的Token，具體API請參見云端資源服務的獲取云端資源token。 |
- | language | String | 否 | 用于傳遞多語言信息，該參數(shù)僅調用客戶端API時生效。 |
params | - | - | 否 | 業(yè)務請求參數(shù)，具體內容因不同的接口而不同，部分接口可能不需要入?yún)ⅲ瑑H通過默認的用戶鑒權信息即可操作，具體請參見相應的接口文檔。 |
公共返回參數(shù)
生活物聯(lián)網(wǎng)平臺提供的所有API都遵循一致的出參規(guī)范，其中如下字段為接口調用時返回的公共字段。
參數(shù) | 類型 | 必有 | 描述 |
id | String | 是 | 用于識別請求記錄，即對應的請求ID。 |
code | Int | 是 | 接口返回碼字段，請求成功時返回200；請求失敗時返回詳細的錯誤碼，錯誤碼介紹請參見錯誤碼字典。 |
message | String | 是 | 接口返回信息字段，請求成功返回success；請求失敗返回錯誤原因。 |
data | - | 否 | 接口返回值字段，每個接口的返回值皆可自定義（部分接口沒有返回值，僅通過返回碼標識請求成功或失敗）。 |