文档首页/ 人证核身服务 IVS/ SDK参考/ C++ SDK

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

查看PDF

C++ SDK

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

准备工作

注册华为账号并开通华为云，并完成实名认证，账号不能处于欠费或冻结状态。
已具备开发环境，支持 C++ 14 及以上版本，要求安装 CMake 3.10 及以上版本。
登录“我的凭证 > 访问秘钥”页面，获取Access Key（AK）和Secret Access Key（SK）。
图1 获取AK、SK
登录“我的凭证”页面，获取“IAM用户名”“、账号名”以及待使用区域的“项目ID”。调用服务时会用到这些信息，请提前保存。
本样例以“华北-北京四”区域为例，获取对应的项目ID（project_id）。

图2 我的凭证

安装SDK

在Linux系统上安装SDK

获取依赖包

所需的这些第三方软件包在大部分系统的包管理工具中都有提供，例如基于 Debian/Ubuntu 的系统。

sudo apt-get install libcurl4-openssl-dev libboost-all-dev libssl-dev libcpprest-dev

spdlog 需要从源码进行安装。

git clone https://github.com/gabime/spdlog.git
cd spdlog
mkdir build
cd build
cmake -DCMAKE_POSITION_INDEPENDENT_CODE=ON ..  // 用以生成动态库
make
sudo make install

编译安装

git clone https://github.com/huaweicloud/huaweicloud-sdk-cpp-v3.git
cd huaweicloud-sdk-cpp-v3
mkdir build
cd build
cmake ..
make
sudo make install

完成上述操作后，C++ SDK 安装目录为 /usr/local。

在Windows系统上安装SDK
1. 安装 vcpkg 并使用 vcpkg 安装所需软件包
```
vcpkg install curl cpprestsdk boost openssl spdlog
```
2. 使用CLion进行编译
  1. 使用CLion打开huaweicloud-sdk-cpp-v3 目录。
  2. 选择“File > Settings”。
  3. 选择“Build, Execution, Deployment > > CMake”。
  4. 在CMake options中加入：
```
-DCMAKE_TOOLCHAIN_FILE={your vcpkg install dir}/scripts/buildsystems/vcpkg.cmake
```
  5. 右键 CMakeLists.txt 选择 Load CMake Project。
  6. 选择Build开始编译。
3. 安装C++ SDK
  编译完成后选择“Build > Install”。
  
  完成上述操作后，C++ SDK 安装目录为 C:\Program File (x86)\huaweicloud-sdk-cpp-v3。

开始使用SDK

导入依赖模块

#include <cstdlib>
#include <iostream>
#include <string>
#include <memory>
#include <huaweicloud/core/exception/Exceptions.h>
#include <huaweicloud/core/Client.h>
#include <huaweicloud/ivs/v2/IvsClient.h>
using namespace HuaweiCloud::Sdk::Ivs::V2;
using namespace HuaweiCloud::Sdk::Ivs::V2::Model;
using namespace HuaweiCloud::Sdk::Core;
using namespace HuaweiCloud::Sdk::Core::Exception;
using namespace std;

配置客户端连接参数

默认配置

// 使用默认配置
HttpConfig httpConfig = HttpConfig();

网络代理（可选）

// 根据需要配置网络代理
httpConfig.setProxyProtocol("http");
httpConfig.setProxyHost("proxy.huawei.com");
httpConfig.setProxyPort("8080");
httpConfig.setProxyUser("username");
httpConfig.setProxyPassword("password");

超时配置（可选）

// 默认连接超时为60秒，默认读取超时为120秒。可根据需求修改该默认值
httpConfig.setConnectTimeout(60);
httpConfig.setReadTimeout(120);

SSL配置（可选）

// 配置跳过服务端证书验证
httpConfig.setIgnoreSslVerification(true);

配置认证信息
配置AK、SK、projectId信息。华为云通过AK识别用户的身份，通过SK对请求数据进行签名验证，用于确保请求的机密性、完整性和请求者身份的正确性。
```
string ak = getenv("HUAWEICLOUD_SDK_AK");
string sk = getenv("HUAWEICLOUD_SDK_SK");
string projectId = getenv("PROJECT_ID");
auto auth = std::make_unique<BasicCredentials>();
auth->withAk(ak)
   .withSk(sk)
   .withProjectId(projectId);
```
认证参数说明：
- ak、sk：访问秘钥信息，获取方法请参见准备工作。
- projectId：华为云项目ID，获取方法请参见准备工作。
  - 认证用的 ak 和sk 硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全。
  - 本示例以 ak 和 sk 保存在环境变量中来实现身份验证为例，运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK，HUAWEICLOUD_SDK_SK和PROJECT_ID。
图3 Windows环境新建环境变量

初始化客户端

指定云服务endpoint方式

string endpoint = "https://ivs.cn-north-4.myhuaweicloud.com";
auto client = IvsClient::newBuilder()
        .withCredentials(std::unique_ptr<Credentials>(auth.release()))
        .withHttpConfig(httpConfig)
        .withEndPoint(endpoint)
        .build();

endpoint：华为云各服务应用区域和各服务的终端节点，详情请查看地区和终端节点。

发送请求并查看响应

// 以调用人证核身标准版（三要素）接口 DetectStandardByIdCardImage 为例
DetectStandardByIdCardImageRequest request;
IvsStandardByIdCardImageRequestBody body;
std::vector<ReqDataByIdCardImage> listIvsStandardByIdCardImageRequestBodyDataReqData;
ReqDataByIdCardImage objReqData;
objReqData.setIdcardImage1("身份证人像面图像数据,使用base64编码");
objReqData.setIdcardImage2("身份证国徽面图像数据,使用base64编码");
objReqData.setFaceImage("现场人像图像数据,使用base64编码");
listIvsStandardByIdCardImageRequestBodyDataReqData.push_back(ReqDataByIdCardImage(objReqData));
IvsStandardByIdCardImageRequestBodyData bodyData;
bodyIvsStandardByIdCardImageRequestBodyData.setReqData(listIvsStandardByIdCardImageRequestBodyDataReqData);
Meta bodyMeta;
bodyMeta.setUuid("唯一标识此次请求的ID,用户自定义,不超过64位。");
body.setData(bodyData);
body.setMeta(bodyMeta);
request.setBody(body);
std::cout << "-----begin execute request-------" << std::endl;

异常处理

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

// 捕获和处理不同类型的异常
try {
        auto reponse = client->detectStandardByNameAndId(request);
        std::cout << reponse->getHttpBody() << std::endl;
    } catch (HostUnreachableException& e) {
        std::cout << "host unreachable:" << e.what() << std::endl;
    } catch (SslHandShakeException& e) {
        std::cout << "ssl handshake error:" << e.what() << std::endl;
    } catch (RetryOutageException& e) {
        std::cout << "retryoutage error:" << e.what() << std::endl;
    } catch (CallTimeoutException& e) {
        std::cout << "call timeout:" <<  e.what() << std::endl;
    } catch (ServiceResponseException& e) {
        std::cout << "http status code:" << e.getStatusCode() << std::endl;
        std::cout << "error code:" << e.getErrorCode() << std::endl;
        std::cout << "error msg:" << e.getErrorMsg() << std::endl;
        std::cout << "RequestId:" << e.getRequestId() << std::endl;
    } catch (exception& e) {
        std:cout << "unknown exception:" << e.what() << std::endl;
    }
    std::cout << "------request finished--------" << std::endl;

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

SDK demo 代码解析

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

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

DetectStandardByIdCardImageRequest request;
IvsStandardByIdCardImageRequestBody body;
std::vector<ReqDataByIdCardImage> listIvsStandardByIdCardImageRequestBodyDataReqData;
ReqDataByIdCardImage objReqData;
objReqData.setIdcardImage1("身份证人像面图像数据,使用base64编码");
objReqData.setIdcardImage2("身份证国徽面图像数据,使用base64编码");
objReqData.setFaceImage("现场人像图像数据,使用base64编码,");
listIvsStandardByIdCardImageRequestBodyDataReqData.push_back(ReqDataByIdCardImage(objReqData));
IvsStandardByIdCardImageRequestBodyData bodyData;
bodyIvsStandardByIdCardImageRequestBodyData.setReqData(listIvsStandardByIdCardImageRequestBodyDataReqData);
Meta bodyMeta;
bodyMeta.setUuid("唯一标识此次请求的ID,用户自定义,不超过64位。例如10eb0091-887f-4839-9929-cbc884f1e20e");
body.setData(bodyData);
body.setMeta(bodyMeta);
request.setBody(body);
std::cout << "-----begin execute request-------" << std::endl;
try {
    auto reponse = client->detectStandardByIdCardImage(request);
     std::cout << reponse->getHttpBody() << std::endl;
} catch (HostUnreachableException& e) {
    std::cout << "host unreachable:" << e.what() << std::endl;
} catch (SslHandShakeException& e) {
    std::cout << "ssl handshake error:" << e.what() << std::endl;
} catch (RetryOutageException& e) {
    std::cout << "retryoutage error:" << e.what() << std::endl;
} catch (CallTimeoutException& e) {
    std::cout << "call timeout:" <<  e.what() << std::endl;
} catch (ServiceResponseException& e) {
    std::cout << "http status code:" << e.getStatusCode() << std::endl;
    std::cout << "error code:" << e.getErrorCode() << std::endl;
    std::cout << "error msg:" << e.getErrorMsg() << std::endl;
    std::cout << "RequestId:" << e.getRequestId() << std::endl;
} catch (exception& e) {
    std:cout << "unknown exception:" << e.what() << std::endl;
}
std::cout << "------request finished--------" << std::endl;

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

DetectStandardByNameAndIdRequest request;
IvsStandardByNameAndIdRequestBody body;
std::vector<StandardReqDataByNameAndId> listIvsStandardByNameAndIdRequestBodyDataReqData;
StandardReqDataByNameAndId objReqData;
objReqData.setVerificationName("被验证人的姓名");
objReqData.setVerificationId("被验证人的身份证号码");
objReqData.setFaceImage("现场人像图像数据,使用base64编码");
listIvsStandardByNameAndIdRequestBodyDataReqData.push_back(StandardReqDataByNameAndId(objReqData));
IvsStandardByNameAndIdRequestBodyData bodyData;
bodyIvsStandardByNameAndIdRequestBodyData.setReqData(listIvsStandardByNameAndIdRequestBodyDataReqData);
Meta bodyMeta;
bodyMeta.setUuid("唯一标识此次请求的ID,用户自定义,不超过64位。例如10eb0091-887f-4839-9929-cbc884f1e20e");
body.setData(bodyData);
body.setMeta(bodyMeta);
request.setBody(body);
std::cout << "-----begin execute request-------" << std::endl;
try {
    auto reponse = client->detectStandardByNameAndId(request);
    std::cout << reponse->getHttpBody() << std::endl;
} catch (HostUnreachableException& e) {
    std::cout << "host unreachable:" << e.what() << std::endl;
} catch (SslHandShakeException& e) {
    std::cout << "ssl handshake error:" << e.what() << std::endl;
} catch (RetryOutageException& e) {
    std::cout << "retryoutage error:" << e.what() << std::endl;
} catch (CallTimeoutException& e) {
    std::cout << "call timeout:" <<  e.what() << std::endl;
} catch (ServiceResponseException& e) {
    std::cout << "http status code:" << e.getStatusCode() << std::endl;
    std::cout << "error code:" << e.getErrorCode() << std::endl;
    std::cout << "error msg:" << e.getErrorMsg() << std::endl;
    std::cout << "RequestId:" << e.getRequestId() << std::endl;
} catch (exception& e) {
    std:cout << "unknown exception:" << e.what() << std::endl;
}
std::cout << "------request finished--------" << std::endl;

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

DetectStandardByVideoAndIdCardImageRequest request;
IvsStandardByVideoAndIdCardImageRequestBody body;
std::vector<ReqDataByVideoAndIdCardImage> listDataReqData;
ReqDataByVideoAndIdCardImage objReqData;
objReqData.setIdcardImage1("身份证人像面图像数据,使用base64编码");
objReqData.setIdcardImage2("身份证国徽面图像数据,使用base64编码");
objReqData.setVideo("现场拍摄人像视频数据,使用base64编码");
objReqData.setActions("动作代码顺序列表");
listDataReqData.push_back(ReqDataByVideoAndIdCardImage(objReqData));
IvsStandardByVideoAndIdCardImageRequestBodyData bodyData;
bodyData.setReqData(listDataReqData);
Meta bodyMeta;
bodyMeta.setUuid("唯一标识此次请求的ID,用户自定义,不超过64位。例如10eb0091-887f-4839-9929-cbc884f1e20e");
body.setData(bodyData);
body.setMeta(bodyMeta);
request.setBody(body);

std::cout << "-----begin execute request-------" << std::endl;
try {
    auto reponse = client->detectStandardByVideoAndIdCardImage(request);
    std::cout << reponse->getHttpBody() << std::endl;
} catch (HostUnreachableException& e) {
    std::cout << "host unreachable:" << e.what() << std::endl;
} catch (SslHandShakeException& e) {
    std::cout << "ssl handshake error:" << e.what() << std::endl;
} catch (RetryOutageException& e) {
    std::cout << "retryoutage error:" << e.what() << std::endl;
} catch (CallTimeoutException& e) {
    std::cout << "call timeout:" <<  e.what() << std::endl;
} catch (ServiceResponseException& e) {
    std::cout << "http status code:" << e.getStatusCode() << std::endl;
    std::cout << "error code:" << e.getErrorCode() << std::endl;
    std::cout << "error msg:" << e.getErrorMsg() << std::endl;
    std::cout << "RequestId:" << e.getRequestId() << std::endl;
} catch (exception& e) {
    std:cout << "unknown exception:" << e.what() << std::endl;
}
std::cout << "------request finished--------" << std::endl;

方式四：使用身份证姓名、身份证号码文本和现场拍摄的人像视频数据，实现活体人证核身

DetectStandardByVideoAndNameAndIdRequest request;
IvsStandardByVideoAndNameAndIdRequestBody body;
std::vector<StandardReqDataByVideoAndNameAndId> listDataReqData;
StandardReqDataByVideoAndNameAndId objReqData;
objReqData.setVerificationName("被验证人的姓名");
objReqData.setVerificationId("被验证人的身份证号码");
objReqData.setVideo("现场拍摄人像视频数据,使用base64编码");
objReqData.setActions("动作代码顺序列表");
listDataReqData.push_back(StandardReqDataByVideoAndNameAndId(objReqData));
IvsStandardByVideoAndNameAndIdRequestBodyData bodyData;
bodyData.setReqData(listDataReqData);
Meta bodyMeta;
bodyMeta.setUuid("唯一标识此次请求的ID,用户自定义,不超过64位。例如10eb0091-887f-4839-9929-cbc884f1e20e");
body.setData(bodyData);
body.setMeta(bodyMeta);
request.setBody(body);

std::cout << "-----begin execute request-------" << std::endl;
try {
	auto reponse = client->detectStandardByVideoAndNameAndId(request);
	std::cout << reponse->getHttpBody() << std::endl;
} catch (HostUnreachableException& e) {
	std::cout << "host unreachable:" << e.what() << std::endl;
} catch (SslHandShakeException& e) {
	std::cout << "ssl handshake error:" << e.what() << std::endl;
} catch (RetryOutageException& e) {
	std::cout << "retryoutage error:" << e.what() << std::endl;
} catch (CallTimeoutException& e) {
	std::cout << "call timeout:" <<  e.what() << std::endl;
} catch (ServiceResponseException& e) {
	std::cout << "http status code:" << e.getStatusCode() << std::endl;
	std::cout << "error code:" << e.getErrorCode() << std::endl;
	std::cout << "error msg:" << e.getErrorMsg() << std::endl;
	std::cout << "RequestId:" << e.getRequestId() << std::endl;
} catch (exception& e) {
	std:cout << "unknown exception:" << e.what() << std::endl;
}
std::cout << "------request finished--------" << std::endl;

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

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

DetectExtentionByIdCardImageRequest request;
IvsExtentionByIdCardImageRequestBody body;
std::vector<ExtentionReqDataByIdCardImage> listIvsExtentionByIdCardImageRequestBodyDataReqData;
ExtentionReqDataByIdCardImage objReqData;
objReqData.setIdcardImage1("身份证人像面图像数据,使用base64编码");
objReqData.setIdcardImage2("身份证国徽面图像数据,使用base64编码");
listIvsExtentionByIdCardImageRequestBodyDataReqData.push_back(ExtentionReqDataByIdCardImage(objReqData));
IvsExtentionByIdCardImageRequestBodyData bodyData;
bodyIvsExtentionByIdCardImageRequestBodyData.setReqData(listIvsExtentionByIdCardImageRequestBodyDataReqData);
Meta bodyMeta;
bodyMeta.setUuid("唯一标识此次请求的ID,用户自定义,不超过64位。例如10eb0091-887f-4839-9929-cbc884f1e20e");
body.setData(bodyData);
body.setMeta(bodyMeta);
request.setBody(body);

std::cout << "-----begin execute request-------" << std::endl;
try {
    auto reponse = client->detectExtentionByIdCardImage(request);
    std::cout << reponse->getHttpBody() << std::endl;
} catch (HostUnreachableException& e) {
    std::cout << "host unreachable:" << e.what() << std::endl;
} catch (SslHandShakeException& e) {
    std::cout << "ssl handshake error:" << e.what() << std::endl;
} catch (RetryOutageException& e) {
    std::cout << "retryoutage error:" << e.what() << std::endl;
} catch (CallTimeoutException& e) {
    std::cout << "call timeout:" <<  e.what() << std::endl;
} catch (ServiceResponseException& e) {
    std::cout << "http status code:" << e.getStatusCode() << std::endl;
    std::cout << "error code:" << e.getErrorCode() << std::endl;
    std::cout << "error msg:" << e.getErrorMsg() << std::endl;
    std::cout << "RequestId:" << e.getRequestId() << std::endl;
} catch (exception& e) {
    std:cout << "unknown exception:" << e.what() << std::endl;
}
std::cout << "------request finished--------" << std::endl;

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

DetectExtentionByNameAndIdRequest request;
IvsExtentionByNameAndIdRequestBody body;
std::vector<ExtentionReqDataByNameAndId> listIvsExtentionByNameAndIdRequestBodyDataReqData;
ExtentionReqDataByNameAndId objReqData;
objReqData.setVerificationName("被验证人的姓名");
objReqData.setVerificationId("被验证人的身份证号码");
listIvsExtentionByNameAndIdRequestBodyDataReqData.push_back(ExtentionReqDataByNameAndId(objReqData));
IvsExtentionByNameAndIdRequestBodyData bodyData;
bodyIvsExtentionByNameAndIdRequestBodyData.setReqData(listIvsExtentionByNameAndIdRequestBodyDataReqData);
Meta bodyMeta;
bodyMeta.setUuid("唯一标识此次请求的ID,用户自定义,不超过64位。例如10eb0091-887f-4839-9929-cbc884f1e20e");
body.setData(bodyData);
body.setMeta(bodyMeta);
request.setBody(body);

std::cout << "-----begin execute request-------" << std::endl;
try {
    auto reponse = client->detectExtentionByNameAndId(request);
    std::cout << reponse->getHttpBody() << std::endl;
} catch (HostUnreachableException& e) {
    std::cout << "host unreachable:" << e.what() << std::endl;
} catch (SslHandShakeException& e) {
    std::cout << "ssl handshake error:" << e.what() << std::endl;
} catch (RetryOutageException& e) {
    std::cout << "retryoutage error:" << e.what() << std::endl;
} catch (CallTimeoutException& e) {
    std::cout << "call timeout:" <<  e.what() << std::endl;
} catch (ServiceResponseException& e) {
    std::cout << "http status code:" << e.getStatusCode() << std::endl;
    std::cout << "error code:" << e.getErrorCode() << std::endl;
    std::cout << "error msg:" << e.getErrorMsg() << std::endl;
    std::cout << "RequestId:" << e.getRequestId() << std::endl;
} catch (exception& e) {
    std:cout << "unknown exception:" << e.what() << std::endl;
}
std::cout << "------request finished--------" << std::endl;

代码示例自动生成

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

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

图4 API Explorer
点击放大

上一篇：PHP SDK

意见反馈

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

有帮助没帮助

提供反馈

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

系统繁忙，请稍后重试

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

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

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

字符长度不能超过500

直接提交取消

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

智能客服提问云社区提问

C++ SDK

准备工作

安装SDK

开始使用SDK

SDK demo 代码解析

代码示例自动生成

相关文档

意见反馈

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

7*24

备案

专业服务

退订

建议反馈

售前咨询热线