PHP SDK

准备工作

• 注册华为账号并开通华为云，账号不能处于欠费或冻结状态。
• 已具备开发环境，PHP 5.6 及以上版本，可执行 php --version 检查当前的版本信息。
• 登录“我的凭证 > 访问密钥”页面，依据界面操作指引获取Access Key（AK）和Secret Access Key（SK）。下载的访问密钥为credentials.csv文件，包含AK/SK信息。
  图1 新增访问密钥
  

  

• 登录“我的凭证”页面，获取“IAM用户名”、“账号名”以及待使用区域的“项目ID”。调用服务时会用到这些信息，请提前保存。
  图2 我的凭证
  

安装SDK

推荐使用 Composer 安装 SDK 。

Composer 是 Php 的依赖管理工具，允许您在项目中声明依赖关系并安装这些依赖：

// 安装 Composer
curl -sS https://getcomposer.org/installer | php
// 安装 PHP SDK
composer require huaweicloud/huaweicloud-sdk-php

安装完毕后，你需要引入 Composer 的自动加载文件：

require 'path/to/vendor/autoload.php';

开始使用

1. 导入依赖模块

   <?php
   namespace HuaweiCloud\SDK\Ocr\V1\Model;
   require_once "vendor/autoload.php";
   use HuaweiCloud\SDK\Core\Auth\BasicCredentials;
   use HuaweiCloud\SDK\Core\Http\HttpConfig;
   use HuaweiCloud\SDK\Core\Exceptions\ConnectionException;
   use HuaweiCloud\SDK\Core\Exceptions\RequestTimeoutException;
   use HuaweiCloud\SDK\Core\Exceptions\ServiceResponseException;
   use HuaweiCloud\SDK\Ocr\V1\OcrClient;

2. 配置客户端连接参数
   • 默认配置

     // 使用默认配置
     $config = HttpConfig::getDefaultConfig();

   • 网络代理（可选）

     // 使用代理服务器
     $config->setProxyProtocol('http');
     $config->setProxyHost('proxy.huawei.com');
     $config->setProxyPort(8080);
     $config->setProxyUser('username');
     $config->setProxyPassword('password');

   • 超时配置（可选）

     // 默认连接超时时间为60秒，读取超时时间为120秒。可根据需要修改默认值。
     $config->setTimeout(120);
     $config->setConnectionTimeout(60);

   • SSL配置（可选）

     // 配置跳过服务端证书验证
     $config->setIgnoreSslVerification(true);
     // 配置服务器端CA证书，用于SDK验证服务端证书合法性
     $config->setCertFile("{yourCertFile}");

3. 配置认证信息
   配置AK、SK、projectId信息。华为云通过AK识别用户的身份，通过SK对请求数据进行签名验证，用于确保请求的机密性、完整性和请求者身份的正确性。

   // 终端节点以 OCR 服务亚太-曼谷的 endpoint 为例
   $ak = getenv('HUAWEICLOUD_SDK_AK');
   $sk = getenv('HUAWEICLOUD_SDK_SK');
   $endpoint = "https://ocr.ap-southeast-2.myhuaweicloud.com";
   $projectId = getenv('PROJECT_ID');
   $credentials = new BasicCredentials($ak,$sk,$projectId);

   

   • 认证用的 ak 和sk 硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全。
   • 本示例以 ak 和 sk 保存在环境变量中来实现身份验证为例，运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。

   认证参数说明：

   • ak、sk：访问密钥信息，获取方法请参见准备工作。
   • projectId：华为云项目ID，获取方法请参见准备工作。
   • endpoint：华为云各服务应用区域和各服务的终端节点，详情请查看 地区和终端节点。
4. 初始化客户端

   指定云服务endpoint方式

   $client = OcrClient::newBuilder(new OcrClient)
     ->withHttpConfig($config)
     ->withEndpoint($endpoint)
     ->withCredentials($credentials)
     ->build();

5. 发送并查看响应

   // 以调用通用护照识别接口 RecognizePassport 为例
   $request = new RecognizePassportRequest();
   $body = new PassportRequestBody();
   $body->setUrl("图片的url");
   $request->setBody($body);
   try {
     $response = $client->RecognizePassport($request);
   } catch (ConnectionException $e) {
     $msg = $e->getMessage();
     echo "\n". $msg ."\n";
   } catch (RequestTimeoutException $e) {
     $msg = $e->getMessage();
     echo "\n". $msg ."\n";
   } catch (ServiceResponseException $e) {
     echo "\n";
     echo $e->getHttpStatusCode(). "\n";
     echo $e->getErrorCode() . "\n";
     echo $e->getErrorMsg() . "\n";
   }
   echo "\n";
   echo $response;

6. 异常处理

   表1 异常处理

   一级分类	一级分类说明	二级分类	二级分类说明
   ConnectionException	连接类异常	HostUnreachableException	网络不可达、被拒绝。
   		SslHandShakeException	SSL认证异常。
   RequestTimeoutException	响应超时异常	CallTimeoutException	单次请求，服务器处理超时未返回。
   		RetryOutageException	在重试策略消耗完成后，仍无有效的响应。
   ServiceResponseException	服务器响应异常	ServerResponseException	服务端内部错误，Http响应码：[500,]。
   		ClientRequestException	请求参数不合法，Http响应码：[400, 500)

   try {
     $response = $client->RecognizePassport($request);
   } catch (ConnectionException $e) {
     $msg = $e->getMessage();
     echo "\n". $msg ."\n";
   } catch (RequestTimeoutException $e) {
     $msg = $e->getMessage();
     echo "\n". $msg ."\n";
   } catch (ServiceResponseException $e) {
     echo "\n";
     echo $e->getHttpStatusCode(). "\n";
     echo $e->getErrorCode() . "\n";
     echo $e->getErrorMsg() . "\n";
   }
   echo "\n";
   echo $response;

代码示例自动生成

API Explorer提供API检索及平台调试，支持全量快速检索、可视化调试、帮助文档查看、在线咨询。

您只需要在API Explorer中修改接口参数，即可自动生成对应的代码示例。

图3 API Explorer