全部产品
Search
文档中心

阿里云物联网平台:PHP SDK使用说明

更新时间:Aug 07, 2023

物联网平台提供PHP语言的云端SDK供开发人员使用。本文介绍云端PHP SDK的安装和配置,及使用PHP SDK调用云端API的示例。

安装PHP SDK

IoT PHP SDK是Alibaba Cloud SDK for PHP的一部分。如果您已安装Alibaba Cloud SDK for PHP,则无需再安装IoT PHP SDK。

  1. 安装PHP开发环境。

    需安装PHP 5.5.0或更高版本。访问PHP官网下载PHP安装包,并完成安装。

  2. 安装Composer。

    目前,通过Composer管理IoT PHP SDK,因此需在系统中安装Composer。

    • Windows系统用户,请访问getcomposer.org,下载、安装Composer-Setup.exe

    • 使用cURL命令安装Composer。

      curl -sS https://getcomposer.org/installer | php
    说明

    如果由于网络问题无法安装,可以使用阿里云Composer全量镜像

  3. 添加以下依赖,安装IoT PHP SDK。

    composer require alibabacloud/iot

    PHP SDK详情和使用指导,请参见openapi-sdk-php-iotAlibaba Cloud SDK for PHP

初始化SDK

以调用华东2(上海)地域的API为例,初始化代码如下。

首先创建对象$iClientProfile,存放SDK初始化信息,然后创建DefaultAcsClient对象实例$client,通过DefaultAcsClient($iClientProfile)方法,加载SDK信息,完成SDK客户端初始化。

include_once 'aliyun-php-sdk-core/Config.php';
use \Iot\Request\V20180120 as Iot;
//设置您的AccessKeyId/AccessSecret/ProductKey
$accessKeyId = getenv('ACCESS_KEY_ID');
$accessSecret = getenv('ACCESS_KEY_SECRET');
$iClientProfile = DefaultProfile::getProfile("cn-shanghai", $accessKeyId, $accessSecret);
$client = new DefaultAcsClient($iClientProfile);

参数

说明

$iClientProfile

用于存放SDK初始化信息,其中cn-shanghai是您的物联网平台服务的地域代码。

您可在物联网平台控制台左上方,查看当前服务所在地域。

地域代码的表达方法,请参见支持的地域

发起调用

物联网平台云端SDK为每个API封装了一个类,命名为${API名称}+"Request",用于API的调用请求。通过该类的对象实例$request,使用"set"+${请求参数的名称}方法,设置请求参数值。通过初始化SDK的对象实例$client,使用getAcsResponse($request)方法,承载API调用结果。

物联网平台云端API,请参见API列表。有关request中请求参数说明,及response中返回参数说明,请参见对应API文档。

本文以调用Pub接口发布消息到Topic为例。请求参数信息,请参见Pub

重要

以下代码中${iotInstanceId}为实例ID值。您可在物联网平台控制台的实例概览页面,查看当前实例的ID值。

  • 若有ID值,必须传入该ID值,否则调用API会失败。

  • 若无实例概览页面或ID值,则无需传入。您需删除IotInstanceId相关的请求代码,或传入空值"",否则调用API会失败。

实例的详细内容,请参见实例概述。购买实例方法,请参见购买企业版实例。常见问题,请参见物联网平台实例相关问题

$request = new Iot\PubRequest();
$request->setIotInstanceId("iotInstanceId"); 
$request->setProductKey("productKey");
$request->setMessageContent("aGVsbG93b3JsZA="); //hello world Base64 String.
$request->setTopicFullName("/productKey/deviceName/user/get"); //消息发送到的Topic全名.
$response = $client->getAcsResponse($request);
print_r($response);

附录:示例代码

前往物联网平台云端SDK示例中心查看或下载API调用的示例代码。示例代码中包含Java、Python、PHP、.NET和Go版本SDK示例。

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