使用OpenAPI调试和集成服务端API - ID Verification

ID Verification产品的集成包括客户端和服务端，其中服务端API可通过阿里云OpenAPI平台在线调试，并获取集成示例代码。本文为您介绍使用阿里云OpenAPI平台在线调试并获取集成服务端API示例代码的详细步骤。

前提条件

您已完成开通ID Verification服务文档的阅读，并开通了ID Verification服务。

说明

不同API服务提供的接入点可能不同，请以对应API文档中说明为准。

阿里云为开发者封装了常见编程语言的SDK，推荐开发者通过集成SDK直接调用所需API而无需关心技术细节。

如果现有SDK不能满足使用需求，可通过自行构造签名使用原生HTTPS调用，但由于自签名细节非常复杂，会给您带来较多额外工作量，请结合业务需求综合评判。

调用方式	备注
阿里云SDK	ID Verification SDK具体支持的编程语言、SDK版本、安装方法请参考 ID Verification SDK中心。

您可以通过API文档中的在线调试和集成章节，直接进入对应API的调用结果或SDK示例页面。

序号	步骤说明
1	进入ID Verification OpenAPI门户，并登录阿里云账号。
2	选择或搜索需要调试的接口。如果是通过API文档入口进入，会直接导航到对应接口页面。
3	选择可以接入的服务地址（接入点），选择的接入点会显示在右侧代码中。说明不同API服务提供的接入点可能不同，请以对应API文档中说明为准。
4	输入调试参数。填充了值的参数字段会显示在右侧代码中。如果您需要在线调用接口，以查看返回数据，可单击参数区域右下角发起调用，可实时在线调用接口，右侧Tab会自动跳转到调用结果页。说明若是付费接口，可能产生费用。
5	在页面右侧区域的顶部，单击SDK示例。
6	按需选择SDK版本和所需编程语言。说明 SDK版本推荐选择`V2.0`，拥有更安全和快捷的集成方式。
7	接入点、接口参数、SDK版本和编程语言的选择改变后，对应的代码会实时改变。代码区域左上角：单击运行示例可在线运行代码。单击下载完整工程，可下载显示代码的工程到本地。代码区域右上角：单击SDK文档可查看对应版本SDK的详细信息。单击SDK安装信息可获取对应版本和编程语言SDK的依赖安装方式。

警告

在实际编码中，使用的阿里云SDK提供的Client类请进行复用，不要每次请求都进行创建，否则可能会引发性能问题。

访问凭据是指用户证明其身份的一组信息。当您在本地使用代码调用ID Verification接口时，需要提供正确的访问凭据才能验证身份。常见的访问凭据类型：

AccessKey：访问密钥AccessKey（简称AK）是阿里云提供给阿里云账号（主账号）和RAM用户（子账号）的永久访问凭据，一组由AccessKey ID和AccessKey Secret组成的密钥对。更多信息，请参见创建AccessKey。
STS Token：安全令牌（STS Token）是阿里云提供给RAM角色的临时访问凭据，可以自定义时效和访问权限。更多信息，请参见什么是STS。

说明

如果您使用RAM用户或RAM角色调用ID Verification接口，在创建上述RAM用户或RAM角色之后，请联系系统管理员授予如下权限：

权限策略名称	备注
AliyunAntCloudAuthFullAccess	调用ID Verification- KYC服务的权限。

访问凭据一旦发生泄露，会给您的业务带来巨大的安全隐患，如何安全的配置和使用访问凭据，请参考下面的方案：

凭据类型	方案名称	适用场景
AccessKey	在Linux、macOS和Windows系统配置环境变量	使用配置系统环境变量的方式，访问阿里云OpenAPI。
STS Token	容器实例角色扮演	如果您的应用程序部署在阿里云ACK容器集群上，则可以基于RRSA（RAM Roles for Service Accounts）功能，在容器集群内实现应用隔离的RAM角色功能，各个应用可以扮演独立的RAM角色，访问阿里云OpenAPI。

关于凭据安全使用的更多方案和细节，请参见使用访问凭据访问阿里云OpenAPI最佳实践。

集成调试过程中，如果出现问题，可以参考下面表格进行排查解决：

我们建议您参照在线调试和示例代码获取章节，基于阿里云OpenAPI门户获取集成实例代码。除此之外，我们额外提供了少量可以直接运行的示例代码供您参考，请参见IDV服务端示例代码。

如果您调ID Verification提供的服务端接口耗时过高，你可以参考下面的方式进行排查和优化：服务端网络耗时分析与优化。

如果现有的SDK无法满足您的业务场景，需要自行封装HTTPS请求时，请参见请求结构和签名机制。

序号	步骤说明
1	进入ID Verification OpenAPI门户，并登录阿里云账号。
2	选择或搜索需要调试的接口。如果是通过API文档入口进入，会直接导航到对应接口页面。
3	选择可以接入的服务地址（接入点），选择的接入点会显示在右侧代码中。说明不同API服务提供的接入点可能不同，请以对应API文档中说明为准。
4	输入调试参数。填充了值的参数字段会显示在右侧代码中。如果您需要在线调用接口，以查看返回数据，可单击参数区域右下角发起调用，可实时在线调用接口，右侧Tab会自动跳转到调用结果页。说明若是付费接口，可能产生费用。
5	在页面右侧区域的顶部，单击SDK示例。
6	按需选择SDK版本和所需编程语言。说明 SDK版本推荐选择`V2.0`，拥有更安全和快捷的集成方式。
7	接入点、接口参数、SDK版本和编程语言的选择改变后，对应的代码会实时改变。代码区域左上角：单击运行示例可在线运行代码。单击下载完整工程，可下载显示代码的工程到本地。代码区域右上角：单击SDK文档可查看对应版本SDK的详细信息。单击SDK安装信息可获取对应版本和编程语言SDK的依赖安装方式。