PHP SDK 使用

最近更新时间:2019-09-10 15:06:54

公共参数

名称 类型 描述 必选
Region String 区域参数,用来标识希望操作哪个区域的实例
Timestamp UInt 当前 UNIX 时间戳
Nonce UInt 随机正整数,与 Timestamp 联合起来, 用于防止重放攻击
SecretId String 由腾讯云平台上申请的标识身份的 SecretId
SecretKey String 由腾讯云平台上申请的标识身份的 SecretKey

为简便接口使用,参数 Region、SecretId 和 SecretKey 三个公共参数通过以下接口单独设置:

  • 参数 Region 通过类 TXIoTCloudClient 中 setRegion() 接口进行设置;
  • 参数 SecretId、SecretKey 通过类 TXIoTCloudClient 中 setSecurityCredential() 接口进行设置。

获取密钥

  1. 登录腾讯云访问管理控制台,选择【访问密钥】>【API 密钥管理】。
  2. 进入API 密钥管理页面,单击【新建密钥】。
  3. 新建成功后获取到 SecretIdSecretKey

初始化 SDK

  1. 下载 PHP-SDK 开发包,解压后得到 TXIoTCloud.phar

  2. 在 PHP 文件中引入开发包 TXIoTCloud.phar,例如:

     <?php
     include 'TXIoTCloud.phar';
     use TXIoTCloud\Services\TXIoTCloudClient;
     ...
  3. 初始化 Region、SecretId、SecretKey 等公共参数信息。

     <?php
     include 'TXIoTCloud.phar';
     use TXIoTCloud\Services\TXIoTCloudClient;
    
     // secretId、secretKey 为在腾讯云平台上创建的云 API 密钥 
     $secretId = "your_secretId";
     $secretKey = "your_secretKey";
    
     // 区域参数,用来标识希望操作哪个区域的实例,如广州(gz)
     $region = "gz";
    
     $client = new TXIoTCloudClient();
     $client->setSecurityCredential($secretId, $secretKey);
     $client->setRegion($region);
     ...
  4. 若需通过代理发起请求,调用类 TXIoTCloudClient 中的 setProxy() 接口进行设置。

     <?php
     include 'TXIoTCloud.phar';
     use TXIoTCloud\Services\TXIoTCloudClient;
    
     // 代理服务器域名或IP
     $proxyServer = "127.0.0.1";
    
     // 代理服务器端口
     $proxyPort = "8000";
    
     $client->setProxy($proxyServer, $proxyPort);
     ...

接口调用

以创建产品 ( createProduct() ) 为例 :

<?php
include 'TXIoTCloud.phar';
use TXIoTCloud\Request as IoT;
use TXIoTCloud\Services\TXIoTCloudClient;

$timestamp = time();
$nonce = random_int(1, PHP_INT_MAX);
$productName = "test_product";
$productDescription = "测试产品";
$productRegion = "gz";

$createProductRequest = new IoT\CreateProductRequest($timestamp, $nonce, $productName, $productDescription, $productRegion);
$createProductResponse = $client->createProduct($createProductRequest);
...

接口说明

腾讯物联网通信客户端接口 - TXIoTCloudClient

序号 方法名 说明
1 setProxy 设置代理
2 setSecurityCredential 设置安全凭证
3 setRegion 设置区域参数
4 createProduct 创建产品
5 deleteProduct 删除产品
6 listProducts 查询产品列表
7 createDevice 创建设备
8 deleteDevice 删除设备
9 getDeviceShadow 获取虚拟设备信息
10 updateDeviceShadow 更新虚拟设备信息
11 listDevices 查询设备列表
12 createMultiDevice 批量创建设备
13 getCreateMultiDevTask 查询批量创建设备任务的执行状态
14 getMultiDevices 查询批量创建设备的执行结果
15 publish 向某个主题发布消息