文档首页> 人证核身服务 IVS> SDK参考> PHP SDK

更新时间：2024-04-19 GMT+08:00

查看PDF

PHP SDK

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

准备工作

注册华为账号并开通华为云，并完成实名认证，账号不能处于欠费或冻结状态。
已具备开发环境，PHP 5.6 及以上版本，可执行 php --version 检查当前的版本信息。
登录“我的凭证 > 访问秘钥”页面，获取Access Key（AK）和Secret Access Key（SK）。
图1 获取AK、SK
登录“我的凭证”页面，获取“IAM用户名”“、账号名”以及待使用区域的“项目ID”。调用服务时会用到这些信息，请提前保存。
本样例以“华北-北京四”区域为例，获取对应的项目ID（project_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';

开始使用SDK

导入依赖模块

<?php
namespace HuaweiCloud\SDK\Ivs\V2\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\Ivs\V2\IvsClient;

配置客户端连接参数

默认配置

// 使用默认配置
$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}");

配置认证信息
配置AK、SK、projectId信息。华为云通过AK识别用户的身份，通过SK对请求数据进行签名验证，用于确保请求的机密性、完整性和请求者身份的正确性。
```
// 终端节点以 IVS 服务北京四的 endpoint 为例
$ak = getenv('HUAWEICLOUD_SDK_AK');
$sk = getenv('HUAWEICLOUD_SDK_SK');
$endpoint = "https://ivs.cn-north-4.myhuaweicloud.com";
$projectId = getenv('PROJECT_ID');
$credentials = new BasicCredentials($ak,$sk,$projectId);
```
认证参数说明：
- ak、sk：访问秘钥信息，获取方法请参见准备工作。
- projectId：华为云项目ID，获取方法请参见准备工作。
- endpoint：华为云各服务应用区域和各服务的终端节点，详情请查看地区和终端节点。
  - 认证用的 ak 和sk 硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全。
  - 本示例以 ak 和 sk 保存在环境变量中来实现身份验证为例，运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK，HUAWEICLOUD_SDK_SK和PROJECT_ID。
图3 Windows环境新建环境变量

初始化客户端

指定云服务endpoint方式

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

发送并查看响应

// 以调用人证核身标准版（三要素）接口 DetectStandardByIdCardImage 为例
$request = newDetectStandardByIdCardImageRequest();
$body = newIvsStandardByIdCardImageRequestBody();
$listIvsStandardByIdCardImageRequestBodyDataReqData = array();
array_push($listIvsStandardByIdCardImageRequestBodyDataReqData,(newReqDataByIdCardImage())
    ->setIdcardImage1("身份证人像面图像数据,使用base64编码")
    ->setIdcardImage2("身份证国徽面图像数据,使用base64编码")
    ->setFaceImage("现场人像图像数据,使用base64编码")
 );
$databody = newIvsStandardByIdCardImageRequestBodyData();
$databody->setReqData($listIvsStandardByIdCardImageRequestBodyDataReqData);
$metabody = newMeta();
$metabody->setUuid("唯一标识此次请求的ID,用户自定义,不超过64位。");
$body->setData($databody);
$body->setMeta($metabody);
$request->setBody($body);
try {
  $response = $client->DetectStandardByIdCardImage($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";

异常处理

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

// 捕获和处理不同类型的异常
try {
  $response = $client->DetectStandardByNameAndId($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;

使用异步客户端，配置日志等操作请参见SDK中心、PHP SDK使用指导、PHP SDK使用视频。

SDK demo 代码解析

人证核身标准版（三要素）

方式一：使用身份证图片、人像图片进行校验

$request = newDetectStandardByIdCardImageRequest();
$body = newIvsStandardByIdCardImageRequestBody();
$listIvsStandardByIdCardImageRequestBodyDataReqData = array();
array_push($listIvsStandardByIdCardImageRequestBodyDataReqData,(newReqDataByIdCardImage())
    ->setIdcardImage1("身份证人像面图像数据,使用base64编码")
    ->setIdcardImage2("身份证国徽面图像数据,使用base64编码")
    ->setFaceImage("现场人像图像数据,使用base64编码,")
 );
$databody = newIvsStandardByIdCardImageRequestBodyData();
$databody->setReqData($listIvsStandardByIdCardImageRequestBodyDataReqData);
$metabody = newMeta();
$metabody->setUuid("唯一标识此次请求的ID,用户自定义,不超过64位。例如10eb0091-887f-4839-9929-cbc884f1e20e");
$body->setData($databody);
$body->setMeta($metabody);
$request->setBody($body);
try {
  $response = $client->DetectStandardByIdCardImage($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;

方式二：使用身份证姓名、身份证号码文本，人像图片进行校验

$request = newDetectStandardByNameAndIdRequest();
$body = newIvsStandardByNameAndIdRequestBody();
$listIvsStandardByNameAndIdRequestBodyDataReqData = array();
array_push($listIvsStandardByNameAndIdRequestBodyDataReqData,(newStandardReqDataByNameAndId())
    ->setVerificationName("被验证人的姓名")
    ->setVerificationId("被验证人的身份证号码")
    ->setFaceImage("现场人像图像数据,使用base64编码")
 );
$databody = newIvsStandardByNameAndIdRequestBodyData();
$databody->setReqData($listIvsStandardByNameAndIdRequestBodyDataReqData);
$metabody = newMeta();
$metabody->setUuid("唯一标识此次请求的ID,用户自定义,不超过64位。例如10eb0091-887f-4839-9929-cbc884f1e20e");
$body->setData($databody);
$body->setMeta($metabody);
$request->setBody($body);
try {
  $response = $client->DetectStandardByNameAndId($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;

方式三：使用现场拍摄的人像视频数据，实现活体人证核身

$request = new DetectStandardByVideoAndIdCardImageRequest();
$body = new IvsStandardByVideoAndIdCardImageRequestBody();
$listDataReqData = array();
array_push($listDataReqData,(new ReqDataByVideoAndIdCardImage())
    ->setIdcardImage1("身份证人像面图像数据,使用base64编码")
    ->setIdcardImage2("身份证国徽面图像数据,使用base64编码")
    ->setVideo("现场拍摄人像视频数据,使用base64编码")
    ->setActions("动作代码顺序列表")
 );
$databody = new IvsStandardByVideoAndIdCardImageRequestBodyData();
$databody->setReqData($listDataReqData);
$metabody = new Meta();
$metabody->setUuid("唯一标识此次请求的ID,用户自定义,不超过64位。例如10eb0091-887f-4839-9929-cbc884f1e20e");
$body->setData($databody);
$body->setMeta($metabody);
$request->setBody($body);
try {
  $response = $client->DetectStandardByVideoAndIdCardImage($request);
  echo "\n";
  echo $response;
} 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->getRequestId(). "\n";
  echo $e->getErrorCode() . "\n";
  echo $e->getErrorMsg() . "\n";
}

人证核身证件版（二要素）

方式一：使用身份证图片进行校验

$request = newDetectExtentionByIdCardImageRequest();
$body = newIvsExtentionByIdCardImageRequestBody();
$listIvsExtentionByIdCardImageRequestBodyDataReqData = array();
array_push($listIvsExtentionByIdCardImageRequestBodyDataReqData,(newExtentionReqDataByIdCardImage())
    ->setIdcardImage1("身份证人像面图像数据,使用base64编码")
    ->setIdcardImage2("身份证国徽面图像数据,使用base64编码")
 );
$databody = newIvsExtentionByIdCardImageRequestBodyData();
$databody->setReqData($listIvsExtentionByIdCardImageRequestBodyDataReqData);
$metabody = newMeta();
$metabody->setUuid("唯一标识此次请求的ID,用户自定义,不超过64位。例如10eb0091-887f-4839-9929-cbc884f1e20e");
$body->setData($databody);
$body->setMeta($metabody);
$request->setBody($body);
try {
  $response = $client->DetectExtentionByIdCardImage($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;

方式二：使用身份证姓名、身份证号码文本进行校验

$request = newDetectExtentionByNameAndIdRequest();
$body = newIvsExtentionByNameAndIdRequestBody();
$listIvsExtentionByNameAndIdRequestBodyDataReqData = array();
array_push($listIvsExtentionByNameAndIdRequestBodyDataReqData,(newExtentionReqDataByNameAndId())
    ->setVerificationName("被验证人的姓名")
    ->setVerificationId("被验证人的身份证号码")
 );
$databody = newIvsExtentionByNameAndIdRequestBodyData();
$databody->setReqData($listIvsExtentionByNameAndIdRequestBodyDataReqData);
$metabody = newMeta();
$metabody->setUuid("唯一标识此次请求的ID,用户自定义,不超过64位。例如10eb0091-887f-4839-9929-cbc884f1e20e");
$body->setData($databody);
$body->setMeta($metabody);
$request->setBody($body);
try {
  $response = $client->DetectExtentionByNameAndId($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中修改接口参数，即可自动生成对应的代码示例。同时，可在集成开发环境CloudIDE中完成代码的构建、调试和运行等操作。

图4 API Explorer
点击放大

上一篇：Node.js SDK

下一篇：C++ SDK

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

PHP SDK

准备工作

安装SDK

开始使用SDK

SDK demo 代码解析

代码示例自动生成

相关文档

相关产品

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线