调用API

本文档主要介绍调用物联网无线连接服务云端API的请求结构和请求示例。

请求结构

您可以通过发送HTTP或HTTPS请求调用物联网无线连接服务的API。

请求结构如下:

http://Endpoint/?Action=xx&Parameters

参数

说明

Endpoint

调用云服务的接入地址。物联网无线连接服务的接入地址:https://linkcard.aliyuncs.com/

Action

要执行的操作,即API的名称。例如:GetCardFlowInfo。要执行的操作,即云端API接口的名称。例如,调用GetCardFlowInfo查询卡的流量信息。Action对应的值就是GetCardFlowInfo,即Action=GetCardFlowInfo。

Parameters

请求参数。每个参数之间用(&)符号分隔。

请求参数由公共请求参数和该API自定义参数组成。公共参数中包含API版本号、身份验证等信息。

下面以调用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
...
说明

为了便于阅读,代码示例做了格式化处理。请求参数说明,请参见公共参数GetCardFlowInfo接口详情。

API在线调试

阿里云OpenAPI开发者门户提供API在线调试工具。在API调试页面,您可以快速检索和体验调用API。系统会根据您输入的参数同步生成各语言SDK的代码示例。各语言SDK代码示例显示在页面右侧SDK示例页签下供您参考。在调用结果页签下,可查看API调用的真实请求URL和JSON格式的返回结果。

API授权

为了确保您的账号安全,建议您使用RAM用户调用API。如果您使用RAM用户调用物联网无线连接服务的API,您需要为该RAM用户创建并授予相应的授权策略。