人证核身服务 IVS-Python SDK:开始使用SDK
开始使用SDK
- 导入依赖模块
from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcore.exceptions import exceptions # 导入IVS的库 from huaweicloudsdkivs.v2.region.ivs_region import IvsRegion from huaweicloudsdkivs.v2 import * import os
- 配置认证信息
配置AK、SK信息。华为云通过AK识别用户的身份,通过SK对请求数据进行签名验证,用于确保请求的机密性、完整性和请求者身份的正确性。AK、SK获取方法请参见准备工作。
// 创建AK、SK认证凭据 def GetCredential(): return BasicCredentials(ak, sk)
初始化认证信息:
ak = os.environ.get("HUAWEICLOUD_SDK_AK") sk = os.environ.get("HUAWEICLOUD_SDK_SK") credentials = GetCredential(ak, sk)
- 认证用的 ak 和sk 硬编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全。
- 本示例以 ak 和 sk 保存在环境变量中来实现身份验证为例,运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。
图3 Windows环境新建环境变量
- 初始化客户端
# 选择服务部署区域 def GetClient(): return IvsClient.new_builder(IvsClient) \ .with_credentials(credentials) \ .with_region(IvsRegion.CN_NORTH_4) \ .build()
CN_NORTH_4:华北-北京四
CN_NORTH_1:华北-北京一
- 发送请求并查看响应
# 以调用标准版(三要素)接口 DetectStandardByIdCardImage 为例 request = DetectStandardByIdCardImageRequest() response = client.detect_standard_by_id_card_image(request) print(response)
- 异常处理
表1 异常处理 一级分类
一级分类说明
二级分类
二级分类说明
ConnectionException
连接类异常
HostUnreachableException
网络不可达、被拒绝。
SslHandShakeException
SSL认证异常。
RequestTimeoutException
响应超时异常
CallTimeoutException
单次请求,服务器处理超时未返回。
RetryOutageException
在重试策略消耗完成后,仍无有效的响应。
ServiceResponseException
服务器响应异常
ServerResponseException
服务端内部错误,Http响应码:[500,]。
ClientRequestException
请求参数不合法,Http响应码:[400, 500)
# 异常处理 try: request = DetectStandardByIdCardImageRequest() response = client.detect_standard_by_id_card_image(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg)