文档中心>人脸核身>其他指引>三分钟跑通接口

三分钟跑通接口

最近更新时间:2023-06-26 15:29:11

我的收藏

操作场景

该任务指导您在购买腾讯云人脸核身服务后,通过 API 3.0 Explorer 在线接口调试页面调用腾讯云人脸核身接口,并将该接口对应语言的 SDK 集成到项目。您只需要完成以下步骤,即可快速接入腾讯云人脸核身接口。

前提条件

在调用人脸核身接口前,您需要先 申请开通腾讯云人脸核身服务,并通过审核。 审核成功后,进入腾讯云人脸核身 API 3.0 Explorer 在线接口调试页面,按照下面的操作步骤调用接口。

操作步骤

步骤1:在左侧导航栏,选择需要调用的接口。





步骤2:输入参数中的必填参数。




Region 参数:
域名中的地域信息,该参数决定访问的接入点,例如 faceid.ap-shanghai.tencentcloudapi.com 表示要访问“上海”接入点。
公共参数 Region 决定要访问业务资源所在区,例如 Region=ap-beijing 则表示需操作北京区的资源。如果域名中不指定地域信息,则默认就近接入,但由于就近接入可能会存在问题,如果解析不到 IP 最终会默认接入广州地域。
域名地域和公共参数 Region 可以不一致,但可能会增加耗时。建议域名和公共参数 Region 选择就近相同的地域。例如,华南地区(广州),ap-guangzhou。
RuleId 参数:用于细分客户使用场景,申请开通服务后,可以在 腾讯云人脸核身控制台 自助接入里面创建,审核通过后即可调用。如有疑问,点此链接 扫描二维码添加腾讯云人脸核身小助手进行询问。

步骤3:选择语言生成对应代码。

您填写左侧的参数值,然后生成代码,生成代码中的部分字段信息和填写内容是关联的。如需调整传入参数,要在左侧修改参数值后重新生成代码。



步骤4:集成 SDK 到项目。

参考右上角的 SDK 使用说明,将 SDK 引入到项目,通过 步骤3 生成的代码即可调用对应的接口。



注意事项

使用 SDK 调用人脸核身服务时,公共参数需要关注 Region 字段,建议域名和 Region 统一使用 “ap-guangzhou”。
SecretId/SecretKey 生成地址:https://console.cloud.tencent.com/cam/capi
图片/视频转 Base64 时,需要去掉相关前缀data:image/jpg;base64,和换行符\\n
如果请求结果提示如下,需要手动设置签名类型:
[TencentCloudSDKException]message:AuthFailure.SignatureFailure-The provided credentials
could not be validated because of exceeding request size limit, please use new signature
method `TC3-HMAC-SHA256`. requestId:719970d4-5814-4dd9-9757-a3f11ecc9b20
设置签名类型:
clientProfile.setSignMethod("TC3-HMAC-SHA256"); // 指定签名算法(默认为 HmacSHA256)
如果接口请求内容超过1M,只能使用 V3 鉴权(TC3-HMAC-SHA256),API 3.0 SDK 支持语言:Node、Python、Java、PHP、Go。其他语言如 .net、C# 暂时不支持 SDK 方式调用,需要自行实现 接口鉴权V3 进行接口调用,建议使用 API 3.0 Explorer 中签名串生成工具进行核验签名有效性。