調(diào)用API
本文檔主要介紹調(diào)用物聯(lián)網(wǎng)無線連接服務(wù)云端API的請求結(jié)構(gòu)和請求示例。
請求結(jié)構(gòu)
您可以通過發(fā)送HTTP或HTTPS請求調(diào)用物聯(lián)網(wǎng)無線連接服務(wù)的API。
請求結(jié)構(gòu)如下:
http://Endpoint/?Action=xx&Parameters
參數(shù) | 說明 |
Endpoint | 調(diào)用云服務(wù)的接入地址。物聯(lián)網(wǎng)無線連接服務(wù)的接入地址: |
Action | 要執(zhí)行的操作,即API的名稱。例如:GetCardFlowInfo。要執(zhí)行的操作,即云端API接口的名稱。例如,調(diào)用GetCardFlowInfo查詢卡的流量信息。Action對應(yīng)的值就是GetCardFlowInfo,即Action=GetCardFlowInfo。 |
Parameters | 請求參數(shù)。每個參數(shù)之間用(&)符號分隔。 請求參數(shù)由公共請求參數(shù)和該API自定義參數(shù)組成。公共參數(shù)中包含API版本號、身份驗證等信息。 |
下面以調(diào)用GetCardFlowInfo接口,查詢卡的流量信息為例:
"http://linkcard.aliyuncs.com/
?AccessKeyId=ACS**********MrZtwL
&Action=GetCardFlowInfo
&Format=JSON
&Iccid=12**************
&SignatureMethod=HMAC-SHA1
&SignatureNonce=ea8cf48************e7c734c7ac3
&SignatureVersion=1.0
&Timestamp=2021-12-23T06%3A42%3A34Z
&Version=2021-05-20
&Signature=QC%2F7HaQl*************dK18U%3D
...
為了便于閱讀,代碼示例做了格式化處理。請求參數(shù)說明,請參見公共參數(shù)和GetCardFlowInfo接口詳情。
API在線調(diào)試
阿里云OpenAPI開發(fā)者門戶提供API在線調(diào)試工具。在API調(diào)試頁面,您可以快速檢索和體驗調(diào)用API。系統(tǒng)會根據(jù)您輸入的參數(shù)同步生成各語言SDK的代碼示例。各語言SDK代碼示例顯示在頁面右側(cè)SDK示例頁簽下供您參考。在調(diào)用結(jié)果頁簽下,可查看API調(diào)用的真實請求URL和JSON格式的返回結(jié)果。
API授權(quán)
為了確保您的賬號安全,建議您使用RAM用戶調(diào)用API。如果您使用RAM用戶調(diào)用物聯(lián)網(wǎng)無線連接服務(wù)的API,您需要為該RAM用戶創(chuàng)建并授予相應(yīng)的授權(quán)策略。