更新时间:2024-01-23 GMT+08:00

PHP SDK使用说明

操作场景

使用PHP语言调用APP认证的API时,您需要先获取SDK,然后新建工程,最后参考API调用示例调用API。

本章节以IntelliJ IDEA 2018.3.5版本为例介绍。

前提条件

  • 已获取API的调用信息,具体请参见开发准备
  • 已安装开发工具和PHP开发语言环境,具体请参见开发准备
    • 将PHP安装目录中的“php.ini-production”文件复制到“C:\windows”,改名为“php.ini”,并在文件中增加如下内容。
      extension_dir = "php安装目录/ext"
      extension=openssl
      extension=curl
    • 已在IntelliJ IDEA中安装PHP插件,如果未安装,请按照图1所示安装。
      图1 安装PHP插件

获取SDK

旧版界面:登录ROMA Connect实例控制台,在“服务集成 APIC > API调用”的“SDK”页签中下载SDK。

新版界面:登录ROMA Connect实例控制台,在“服务集成 APIC > 凭据管理”的“SDKs”页签中下载SDK。

解压后目录结构如下:

名称

说明

signer.php

SDK代码

index.php

示例代码

新建工程

  1. 打开IDEA,选择菜单“File > New > Project”。

    弹出“New Project”对话框,选择“PHP”,单击“Next”。

    图2 New Project
  2. 单击“...”,在弹出的对话框中选择解压后的SDK路径,单击“Finish”。
    图3 选择解压后的SDK路径
  3. 完成工程创建后,目录结构如下。
    图4 新建工程的目录结构

    “signer.php”为示例代码,请根据实际情况修改参数后使用。具体代码说明请参考调用API示例

调用API示例

  1. 在代码中引入sdk。
    require 'signer.php';
  2. 生成一个新的Signer, 输入API所授权凭据的Key和Secret,可参考获取API的调用信息获取。
    $signer = new Signer();
    // Directly writing AK/SK in code is risky. For security, encrypt your AK/SK and store them in the configuration file or environment variables. 
    // In this example, the AK/SK are stored in environment variables for identity authentication. Before running this example, set environment variables HUAWEICLOUD_SDK_AK and HUAWEICLOUD_SDK_SK. 
    $signer->Key = getenv('HUAWEICLOUD_SDK_AK');
    $signer->Secret = getenv('HUAWEICLOUD_SDK_SK');
  3. 生成一个新的Request,指定方法名、请求url和body,可参考获取API的调用信息获取。
    $req = new Request('GET', "https://c967a237-cd6c-470e-906f-a8655461897e.apigw.exampleRegion.com/app1?a=1");
    $req->body = '';
  4. 给请求添加x-stage头,内容为环境名。如果有需要,添加需要签名的其他头域。
    $req->headers = array(
        'x-stage' => 'RELEASE',
    );
  5. 进行签名,执行此函数会生成一个$curl上下文变量。
    $curl = $signer->Sign($req);
  6. 若使用系统分配的子域名访问https请求的API,需要忽略证书校验,否则跳过此步。
    curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, 0);
    curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, 0);
  7. 访问API,查看访问结果。
    $response = curl_exec($curl);
    echo curl_getinfo($curl, CURLINFO_HTTP_CODE);
    echo $response;
    curl_close($curl);