调用API
本文主要介绍调用物联网平台云端API的请求结构和请求示例。
请求结构
您可以通过发送HTTP或HTTPS请求调用物联网平台API。
请求结构如下:
http://Endpoint/?Action=****&Parameters
参数 | 说明 |
Endpoint | 调用云服务的接入地址。物联网平台的接入地址格式: |
Action | 要执行的操作,即云端API的接口名称。例如,调用Pub接口向指定Topic发布消息,Action对应的值就是Pub,即 |
Parameters | 调用API的请求参数。每个参数之间用(&)符号分隔。 请求参数由公共请求参数和API自定义请求参数组成。公共参数中包含API版本号、身份验证等信息。 |
请求示例
下文以调用2018-01-20
版本的Pub接口向指定Topic发布消息为例:
本文档示例均使用华东2(上海)地域的接入地址。为了便于阅读,代码示例均做了格式化处理。请求参数说明,请参见公共参数和Pub。
其中AccessKeyId
字段,修改为您阿里云账号或RAM 用户的 创建AccessKey。
阿里云账号AccessKey拥有所有API的访问权限,建议您使用RAM用户进行API访问或日常运维。请妥善保管好您的AccessKey信息。
强烈建议不要将AccessKey ID和AccessKey Secret保存到工程代码里或者任何容易被泄露的地方,AccessKey泄露会威胁您账号下所有资源的安全。
https://iot.cn-shanghai.aliyuncs.com/?Action=Pub
&Format=XML
&Version=2018-01-20
&Signature=Pc5WB8gok***1dgI%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=yourAccessKeyID
&Timestamp=2017-07-19T12:00:00Z
&RegionId=cn-shanghai
...
API在线调试
阿里云OpenAPI开发者门户提供API调试工具。在API调试页面,您可以快速检索和体验调用API。系统会根据您输入的参数同步生成各语言SDK的代码示例。各语言SDK代码示例显示在页面右侧SDK示例页签下供您参考。在调用结果页签下,可查看API调用的真实请求URL和JSON格式的返回结果。