Python SDK调用示例
本文介绍金融级活体人脸验证服务端接入的Python SDK调用示例。
SDK使用说明
如果需要其他语言的SDK示例代码，您可以通过OpenAPI 开发者门户在线调试工具调试API接口，该工具会自动生成相应API的SDK调用示例代码。您可以单击以下接口链接进行调试：
前提条件
需要使用的Python为3.0及以上版本。
已添加认证场景，并获取对应的场景ID。具体操作，请参见添加认证场景。
引入依赖包
pip install alibabacloud_tea_openapi==0.2.5
pip install alibabacloud_credentials==0.3.2安装SDK
关于Python SDK源代码，请参见Python SDK包。
pip install alibabacloud_cloudauth20190307==2.0.3调用示例
InitFaceVerify接口调用示例
关于参数的具体描述，请参见InitFaceVerify。
from alibabacloud_cloudauth20190307.client import Client as CloudauthClient
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_cloudauth20190307 import models as cloudauth_models
from alibabacloud_tea_util.client import Client as UtilClient
from alibabacloud_tea_util import models as util_models
from alibabacloud_credentials.client import Client as CredClient
class InitFaceVerify:
def __init__(self):
pass
@staticmethod
def create_client(
endpoint: str,
) -> CloudauthClient:
# 阿里云账号AccessKey拥有所有API的访问权限，建议您使用RAM用户进行API访问或日常运维。
# 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里，否则可能导致AccessKey泄露，威胁您账号下所有资源的安全。
# 本示例通过阿里云Credentials工具从环境变量中读取AccessKey，来实现API访问的身份验证。如何配置环境变量，请参见 https://help.aliyun.com/zh/sdk/developer-reference/configure-credentials。
cred=CredClient()
config = open_api_models.Config(
credential=cred,
# 设置HTTP代理。
# http_proxy='http://xx.xx.xx.xx:xxxx',
# 设置HTTPS代理。
# https_proxy='https://username:password@xxx.xxx.xxx.xxx:9999',
endpoint=endpoint
)
return CloudauthClient(config)
@staticmethod
def main() -> None:
request = cloudauth_models.InitFaceVerifyRequest(
# 请输入场景ID。
scene_id=0,
outer_order_no='商户请求的唯一标识',
# 要接入的认证方案。
product_code='PV_FV',
model='LIVENESS',
# 固定值IDENTITY_CARD。
cert_type='IDENTITY_CARD',
meta_info='{"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"}',
# cert_name='xxx',
# cert_no='xxx',
# mobile='130xxxxxxxx',
# ip='114.xxx.xxx.xxx',
user_id='12345xxxx',
# callback_url='https://www.aliyundoc.com',
# callback_token='xxxxxxx',
# 请在以下四种方式中选择其一。
# 1.照片Base64编码。
# 2.照片OSS Bucket名和文件名。
# 3.照片OSS的URL地址。
# 4.已经实人认证通过的CertifyId。
# 方式一：照片Base64。
# face_contrast_picture='人脸照片Base64编码'
# 方式二：照片OSS Bucket名和文件名。
# oss_bucket_name='cn-shanghai-aliyun-cloudauth-xxxxx',
# oss_object_name='verify/xxxxx/xxxxxx.jpeg',
# 方式三：照片OSS的URL地址，公网可访问。
face_contrast_picture_url='https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg',
# 方式四：已经实人认证通过的CertifyId。
# certify_id='0bfa7c493f850e5178b9f8613634c9xx'
)
response = InitFaceVerify.init_face_verify_auto_route(request)
# 不支持服务自动路由。
# response = InitFaceVerify.init_face_verify('cloudauth.cn-shanghai.aliyuncs.com', request)
print(response.body.request_id)
print(response.body.code)
print(response.body.message)
print(response.body.result_object.certify_id)
@staticmethod
def init_face_verify_auto_route(
request: cloudauth_models.InitFaceVerifyRequest,
) -> cloudauth_models.InitFaceVerifyResponse:
endpoints = [
'cloudauth.cn-shanghai.aliyuncs.com',
'cloudauth.cn-beijing.aliyuncs.com'
]
for endpoint in endpoints:
try:
response = InitFaceVerify.init_face_verify(endpoint, request)
if UtilClient.equal_number(500, response.status_code):
continue
if response is not None and response.body is not None:
if UtilClient.equal_string("500", response.body.code):
continue
return response
except Exception as err:
print(err)
# 网络异常，切换到下个区域调用。
continue
return None
@staticmethod
def init_face_verify(
endpoint: str,
request: cloudauth_models.InitFaceVerifyRequest,
) -> cloudauth_models.InitFaceVerifyResponse:
client = InitFaceVerify.create_client(endpoint)
# 创建RuntimeObject实例并设置运行参数。
runtime = util_models.RuntimeOptions()
runtime.read_timeout = 10000
runtime.connect_timeout = 10000
return client.init_face_verify_with_options(request, runtime)
if __name__ == '__main__':
InitFaceVerify.main()
DescribeFaceVerify接口调用示例
关于参数的具体描述，请参见DescribeFaceVerify。
from alibabacloud_cloudauth20190307.client import Client as CloudauthClient
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_cloudauth20190307 import models as cloudauth_models
from alibabacloud_tea_util.client import Client as UtilClient
from alibabacloud_tea_util import models as util_models
from alibabacloud_credentials.client import Client as CredClient
class DescribeFaceVerify:
def __init__(self):
pass
@staticmethod
def create_client(
endpoint: str,
) -> CloudauthClient:
# 阿里云账号AccessKey拥有所有API的访问权限，建议您使用RAM用户进行API访问或日常运维。
# 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里，否则可能导致AccessKey泄露，威胁您账号下所有资源的安全。
# 本示例通过阿里云Credentials工具从环境变量中读取AccessKey，来实现API访问的身份验证。如何配置环境变量，请参见 https://help.aliyun.com/zh/sdk/developer-reference/configure-credentials。
cred=CredClient()
config = open_api_models.Config(
credential=cred,
# 设置HTTP代理。
# http_proxy='http://xx.xx.xx.xx:xxxx',
# 设置HTTPS代理。
# https_proxy='https://username:password@xxx.xxx.xxx.xxx:9999',
endpoint=endpoint
)
return CloudauthClient(config)
@staticmethod
def main() -> None:
request = cloudauth_models.DescribeFaceVerifyRequest(
# 请输入场景ID。
scene_id=0,
certify_id='xxx'
)
response = DescribeFaceVerify.describe_face_verify_auto_route(request)
# 不支持服务自动路由。
# response = DescribeFaceVerify.describe_face_verify('cloudauth.cn-shanghai.aliyuncs.com', request)
print(response.body.request_id)
print(response.body.code)
print(response.body.message)
print(response.body.result_object.passed)
print(response.body.result_object.sub_code)
print(response.body.result_object.material_info)
@staticmethod
def describe_face_verify_auto_route(
request: cloudauth_models.DescribeFaceVerifyRequest,
) -> cloudauth_models.DescribeFaceVerifyResponse:
endpoints = [
'cloudauth.cn-shanghai.aliyuncs.com',
'cloudauth.cn-beijing.aliyuncs.com'
]
for endpoint in endpoints:
try:
response = DescribeFaceVerify.describe_face_verify(endpoint, request)
if UtilClient.equal_number(500, response.status_code):
continue
if response is not None and response.body is not None:
if UtilClient.equal_string("500", response.body.code):
continue
return response
except Exception as err:
continue
return None
@staticmethod
def describe_face_verify(
endpoint: str,
request: cloudauth_models.DescribeFaceVerifyRequest,
) -> cloudauth_models.DescribeFaceVerifyResponse:
client = DescribeFaceVerify.create_client(endpoint)
# 创建RuntimeObject实例并设置运行参数。
runtime = util_models.RuntimeOptions()
runtime.read_timeout = 10000
runtime.connect_timeout = 10000
return client.describe_face_verify_with_options(request, runtime)
if __name__ == '__main__':
DescribeFaceVerify.main()