更新时间:2022-05-07 GMT+08:00
分享

PHP SDK

本章节介绍新版PHP SDK,您可以参考本章节进行快速集成开发。

准备工作

  • 已注册华为云帐号,并完成实名认证,帐号不能处于欠费或冻结状态。
  • 已具备开发环境,PHP 5.6 及以上版本,可执行 php --version 检查当前的版本信息。
  • 登录“我的凭证 > 访问秘钥”页面,获取Access Key(AK)和Secret Access Key(SK)。
  • 登录“我的凭证”页面,获取“IAM用户名”“、帐号名”以及待使用区域的“项目ID”。调用服务时会用到这些信息,请提前保存。

    本样例以“华北-北京四”区域为例,获取对应的项目ID(project_id)。

    图1 我的凭证

安装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';

开始使用

详细的SDK介绍,使用异步客户端,配置日志请参见SDK中心PHP SDK使用指导PHP SDK使用视频

  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 = "<YOUR AK>";
    $sk = "<YOUR SK>";
    $endpoint = "https://ocr.cn-north-4.myhuaweicloud.com";
    $projectId = "<YOUR projectId>";
    $credentials = new BasicCredentials($ak,$sk,$projectId);

    认证参数说明:

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

    指定云服务endpoint方式

    $client = OcrClient::newBuilder(new OcrClient)
      ->withHttpConfig($config)
      ->withEndpoint($endpoint)
      ->withCredentials($credentials)
      ->build();
  5. 发送并查看响应
    // 以调用通用表格识别接口 RecognizeGeneralTable 为例
    $request = new RecognizeGeneralTableRequest();
    $body = newGeneralTableRequestBody();
    $body->setUrl("图片的url");
    $request->setBody($body);
    try {
      $response = $client->RecognizeGeneralTable($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->RecognizeGeneralTable($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";

代码示例自动生成

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

您只需要在API Explorer中修改接口参数,即可自动生成对应的代码示例。同时,可在集成开发环境CloudIDE中完成代码的构建、调试、运行等操作。

图2 API Explorer
分享:

    相关文档

    相关产品

close