文档首页/ 人证核身服务 IVS/ 快速入门/ 调用API实现人证核身证件版（二要素）
更新时间：2024-12-17 GMT+08:00
查看PDF
分享

调用API实现人证核身证件版（二要素）

本章节通过Postman调用人证核身证件版（二要素）API为例，帮助您快速体验并熟悉IVS服务的使用方法。

使用IVS服务API的详细步骤如下所示：

步骤1：开通服务

步骤2：配置环境

步骤3：获取API凭证

步骤4：Token认证鉴权

步骤5：调用服务

前提条件

账号已完成实名认证，且不能处于欠费或冻结状态。

步骤1：开通服务

  1. 登录人证核身服务控制台。
  2. 选择需要使用的服务，在操作列单击“开通服务”。本示例中开通人证核身证件版（二要素）API。
    图1 开通服务
  3. 服务开通成功后，开通状态显示“已开通”。

首次使用服务时，需要先申请开通该服务。服务只需要开通一次即可，后面使用时无需再次申请。如未开通服务，调用服务时会提示IVS.0015报错。

步骤2：配置环境

下载并安装Postman，建议使用7.24.0版本。

步骤3：获取API凭证

调用获取Token接口时，需要使用API凭证用于身份认证。当前存在华为云账号、华为账号两种账号体系，两种账号在获取Token时有所差异，请参考以下步骤判断账号类型并获取相应的API凭证。

  1. 通过如何判断当前使用的是“华为云账号”还是“华为账号”判断当前所使用的是哪种账号类型。
  2. 登录“我的凭证”页面，并参考下图获取API凭证（IAM用户名、账号名）。
    图2 获取API凭证（IAM用户名、账号名）

步骤4：Token认证鉴权

Token是用户的访问令牌，承载了用户的身份、权限等信息，用户调用API接口时，需要使用Token进行鉴权。

  1. 打开安装的Postman软件，在Postman界面，选择“New > Collection”，设置相应的名称并单击“Create”完成创建。
    图3 Postman软件
  2. 选择创建的Collection，单击鼠标右键，选择“Add Request”，设置Request name并单击“Save”。
    图4 设置“Add Request”
  3. 请求方式修改为"POST"，输入URL“https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens”。
  4. 在“Headers”列表中添加“KEY”为“Content-Type”，“VALUE”为“application/json”。
    图5 填写请求Header
  5. 选中“Body”的配置项，选中“raw”，在空白处添加以下代码。并填写API凭证。

    示例代码中的user name、domain name请填写步骤3：获取API凭证中获取的IAM用户名、账号名。

    图6 填写请求Body 
    {
    "auth": {
        "identity": {
            "methods": [
                "password"
            ],
            "password": {
                "user": {
                    "name": "IAM用户名",
                    "password": "密码",
                    "domain": {
                        "name": "账号名"
                    }
                }
            }
        },
        "scope": {
            "project": {
                "name": "cn-north-4"
            }
        }
    }
}
  6. 单击右上角“Send”按钮发送请求。获取、复制返回结果中的Token值（关于Token有效期的详细说明请参见获取IAM用户Token（使用密码））。
    图7 获取Token值

步骤5：调用服务

  1. 在Postman中新建一个请求，请求方式为选择"POST"，按要求填写URL。

    人证核身证件版（二要素）API的URL为“https://ivs.cn-north-4.myhuaweicloud.com/v2.0/ivs-idcard-extention”。

    选中“Headers”配置项，KEY、VALUE按下图进行填写，并复制步骤3中获取的Token值到“X-Auth-Token”的“VALUE”中。

    图8 填写请求Header
  2. 填写接口的Body信息。选中“Body”的配置项，选中“raw”，将下方代码填充至请求体中。

    人证核身证件版（二要素）API可用两种方式进行身份校验。详细接口参数介绍请参见API参考。

    • 使用身份证图片进行校验。
    • 使用身份证姓名、身份证号码文本进行校验（本示例使用该方式）。

    uuid：唯一标识此次请求的ID，用户自定义，不超过64位。

    身份证姓名、身份证号码请按实际填写。 
    {
  "meta": {
    "uuid": "10eb0091-887f-4839-9929-cbc884f1e20e"
  },
  "data": {
    "req_data": [
      {
        "verification_name": "张三",
        "verification_id": "44***********07"
      }
    ]
  }
}
    图9 填写请求Body
  3. 单击右上角“Send”按钮发送请求，查看识别结果。返回"valid"、"Successful certification"，表示身份验证成功。
    图10 查看识别结果

相关文档