本文介绍金融级活体人脸验证服务端接入的PHP SDK调用示例。
SDK使用说明
如果需要其他语言的SDK示例代码,您可以通过OpenAPI 开发者门户在线调试工具调试API接口,该工具会自动生成相应API的SDK调用示例代码。您可以单击以下接口链接进行调试:
前提条件
- 仅支持PHP 5.6及以上版本。
- 已添加认证场景,并获取对应的场景ID。具体操作,请参见添加认证场景。
安装SDK
关于PHP SDK源代码,请参见PHP SDK包。
- 通过Composer来管理项目依赖(推荐)
composer require alibabacloud/cloudauth-20190307 2.0.4
- 使用composer.json文件
{ "require": { "alibabacloud/cloudauth-20190307": "2.0.4" } }
如果因网络问题导致无法按照上述操作安装SDK,您可以使用阿里云Composer全量镜像。
调用示例
InitFaceVerify接口调用示例
<?php
namespace AlibabaCloud\SDK\Sample\Verify\PVFV;
use AlibabaCloud\SDK\Cloudauth\V20190307\Cloudauth;
use AlibabaCloud\SDK\Cloudauth\V20190307\Models\InitFaceVerifyRequest;
use AlibabaCloud\SDK\Cloudauth\V20190307\Models\InitFaceVerifyResponse;
use AlibabaCloud\Tea\Utils\Utils;
use Exception;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
class InitFaceVerify
{
/**
* createClient
* @param string $endpoint
* @return Cloudauth
*/
public static function createClient(string $endpoint): Cloudauth
{
$config = new Config([
// 您的AccessKey ID。
"accessKeyId" => "<您的AccessKey ID>",
// 您的AccessKey Secret。
"accessKeySecret" => "<您的AccessKey Secret>",
// 设置HTTP代理。
// "httpProxy" => "<http://xx.xx.xx.xx:xxxx>",
// 设置HTTPS代理
// "httpsProxy" => "<https://xx.xx.xx.xx:xxxx>",
"endpoint" => $endpoint
]);
return new Cloudauth($config);
}
/**
* main
* @throws Exception
*/
public static function main()
{
$request = new InitFaceVerifyRequest([
// 请输入场景ID。
"sceneId" => 0,
"outerOrderNo" => "<商户请求的唯一标识>",
// 要接入的认证方案。
"productCode" => "<PV_FV>",
// 要进行活体检测的类型。
"model" => "<LIVENESS>",
"userId" => "<xxx>",
"certType" => "<IDENTITY_CARD>",
// "certName" => "<张三>",
// "certNo" => "<xxx>",
// MetaInfo环境参数,需要通过客户端SDK获取。
"metaInfo" => '{"zimVer":"3.0.0","appVersion": "1","bioMetaInfo": "4.1.0:11501568,0",
"appName": "com.aliyun.antcloudauth","deviceType": "ios","osVersion": "iOS 10.3.2","apdidToken": "","deviceModel": "iPhone9,1"}',
// 请在以下四种方式中选择其一。
// 1.照片Base64编码。
// 2.照片OSS Bucket名和文件名。
// 3.照片OSS的URL地址。
// 4.已经实人认证通过的CertifyId。
// 方式一:照片Base64。
// "faceContrastPicture" => "<人脸照片Base64编码>",
// 方式二:照片OSS bucket名和文件名。
// "ossBucketName" => "<cn-shanghai-aliyun-cloudauth-xxxxx>",
// "ossObjectName" => "<verify/xxxxx/xxxxxx.jpeg>",
// 方式三:照片OSS的URL地址,公网可访问。
"faceContrastPictureUrl" => "<https://cn-shanghai-aliyun-cloudauth-****.oss-cn-shanghai.aliyuncs.com/verify/****.jpeg>",
// 方式四:已经实人认证通过的CertifyId。
// "certifyId" => "<0bfa7c493f850e5178b9f8613634c9xx>",
// "mobile" => "<xxx>",
// "ip" => "<114.xxx.xxx.xxx>",
// "callbackUrl" => "<https://www.aliyundoc.com>",
// "callbackToken" => "<xxxxxxx>"
]);
// 推荐,支持服务路由。
$response = self::initFaceVerifyAutoRoute($request);
// 不支持服务自动路由。
// $response = self::initFaceVerify("cloudauth.cn-shanghai.aliyuncs.com", $request);
var_dump($response->body->requestId);
var_dump($response->body->code);
var_dump($response->body->message);
var_dump($response->body->resultObject->certifyId);
}
/**
* initFaceVerifyAutoRoute
* @param InitFaceVerifyRequest $request
* @return InitFaceVerifyResponse
* @throws Exception
*/
public static function initFaceVerifyAutoRoute(InitFaceVerifyRequest $request): ?InitFaceVerifyResponse
{
$endpoints = [
"cloudauth.cn-shanghai.aliyuncs.com",
"cloudauth.cn-beijing.aliyuncs.com"
];
foreach ($endpoints as $endpoint) {
try {
$response = self::initFaceVerify($endpoint, $request);
if (Utils::equalNumber(500, $response->statusCode)) {
continue;
}
if(Utils::equalString("500", $response->body->code)){
continue;
}
return $response;
} catch (Exception $err) {
var_dump($err -> getCode());
var_dump($err -> getMessage());
}
}
return null;
}
/**
* initFaceVerify
* @param string $endpoint
* @param InitFaceVerifyRequest $request
* @return InitFaceVerifyResponse
*/
public static function initFaceVerify(string $endpoint, InitFaceVerifyRequest $request): InitFaceVerifyResponse
{
$client = self::createClient($endpoint);
// 创建RuntimeObject实例并设置运行参数。
$runtime = new RuntimeOptions([]);
$runtime->readTimeout = 10000;
$runtime->connectTimeout = 10000;
return $client->initFaceVerifyWithOptions($request, $runtime);
}
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
require_once $path;
}
InitFaceVerify::main();
DescribeFaceVerify接口调用示例
<?php
namespace AlibabaCloud\SDK\Sample\Verify\PVFV;
use AlibabaCloud\SDK\Cloudauth\V20190307\Cloudauth;
use AlibabaCloud\SDK\Cloudauth\V20190307\Models\DescribeFaceVerifyRequest;
use AlibabaCloud\SDK\Cloudauth\V20190307\Models\DescribeFaceVerifyResponse;
use AlibabaCloud\Tea\Utils\Utils;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
use \Exception;
use Darabonba\OpenApi\Models\Config;
class DescribeFaceVerify {
/**
* createClient
* @param string $endpoint
* @return Cloudauth
*/
public static function createClient(string $endpoint): Cloudauth
{
$config = new Config([
// 您的AccessKey ID。
"accessKeyId" => "<您的AccessKey ID>",
// 您的AccessKey Secret。
"accessKeySecret" => "<您的AccessKey Secret>",
// 设置HTTP代理。
// "httpProxy" => "<http://xx.xx.xx.xx:xxxx>",
// 设置HTTPS代理。
// "httpsProxy" => "<https://xx.xx.xx.xx:xxxx>",
"endpoint" => $endpoint
]);
return new Cloudauth($config);
}
/**
* main
* @return void
*/
public static function main(){
$request = new DescribeFaceVerifyRequest();
// 场景ID。
$request->sceneId=0;
// 认证ID。
$request->certifyId="<xxx>";
// 推荐,支持服务路由。
$response = self::describeFaceVerifyAutoRoute($request);
// 不支持服务自动路由。
// $response = self::describeFaceVerify("cloudauth.cn-shanghai.aliyuncs.com", $request);
var_dump($response->body->requestId);
var_dump($response->body->code);
var_dump($response->body->message);
var_dump($response->body->resultObject->passed);
var_dump($response->body->resultObject->subCode);
var_dump($response->body->resultObject->materialInfo);
var_dump($response->body->resultObject->identityInfo);
var_dump($response->body->resultObject->deviceToken);
}
/**
* describeFaceVerifyAutoRoute
* @param DescribeFaceVerifyRequest $request
* @return DescribeFaceVerifyResponse|null
*/
public static function describeFaceVerifyAutoRoute(DescribeFaceVerifyRequest $request): ?DescribeFaceVerifyResponse
{
$endpoints = [
"cloudauth.cn-shanghai.aliyuncs.com",
"cloudauth.cn-beijing.aliyuncs.com"
];
foreach($endpoints as $endpoint){
try {
$response = self::describeFaceVerify($endpoint, $request);
if (Utils::equalNumber(500, $response->statusCode)) {
continue;
}
if(Utils::equalString("500", $response->body->code)){
continue;
}
return $response;
}
catch (Exception $err) {
var_dump($err -> getCode());
var_dump($err -> getMessage());
}
}
return null;
}
/**
* describeFaceVerify
* @param string $endpoint
* @param DescribeFaceVerifyRequest $request
* @return DescribeFaceVerifyResponse
*/
public static function describeFaceVerify(string $endpoint, DescribeFaceVerifyRequest $request): DescribeFaceVerifyResponse
{
$client = self::createClient($endpoint);
// 创建RuntimeObject实例并设置运行参数。
$runtime = new RuntimeOptions([]);
$runtime->readTimeout = 10000;
$runtime->connectTimeout = 10000;
return $client->describeFaceVerifyWithOptions($request, $runtime);
}
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
require_once $path;
}
DescribeFaceVerify::main();