身份证核验Node.js SDK调用示例

本文介绍了身份证核验的Node.js SDK调用示例。

SDK使用说明

如果需要其他语言的SDK示例代码,您可以通过OpenAPI开发者门户在线调试工具调试API接口。该工具会自动生成相应API的SDK调用示例代码,详细信息,请参见:

前提条件

  • 需要使用的Node.js版本在8.0版本及以上。
  • 已添加认证场景,并获取对应的场景ID。具体操作,请参见添加认证场景

安装SDK

关于Node.js SDK源代码,请参见Node.js SDK

建议您使用npm管理依赖包:

npm install @alicloud/tea-util
npm install @alicloud/openapi-client
npm install @alicloud/cloudauth20200618@1.0.5
npm install @alicloud/credentials
说明

Credentials工具配置方法,请参见身份验证配置

调用示例

关于参数的具体描述,请参见身份证核验初始化身份证核验查询

InitSmartVerify接口调用示例

const Config = require("@alicloud/openapi-client");
const CloudAuth = require("@alicloud/cloudauth20200618");
const CloudAuthClient = CloudAuth.default;
const {RuntimeOptions} = require("@alicloud/tea-util");
const { default: Credential } = require('@alicloud/credentials');

     function createClient(endpoint) {
        // 阿里云账号AccessKey拥有所有API的访问权限,建议您使用RAM用户进行API访问或日常运维。
        // 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里,否则可能导致AccessKey泄露,威胁您账号下所有资源的安全。
	      // 本示例通过阿里云Credentials工具从环境变量中读取AccessKey,来实现API访问的身份验证。
        const cred = new Credential();
        const config = new Config.Config({
        credential: cred,
        // 设置Endpoint。
        endpoint: endpoint,
        // 设置HTTP代理。
        // httpProxy: "http://xxx.xxx.xxx.xxx:9999",
        // 设置HTTPS代理。
        // httpsProxy: "https://username:password@xxx.xxx.xxx.xxx:9999",
  });
        return new CloudAuthClient(config)
    }

    async function initSmartVerify(endpoint, request) {
        const client = createClient(endpoint);
        // 创建RuntimeObject实例并设置运行参数。
        const runtime = new RuntimeOptions([]);
        runtime.readTimeout=10000;
        runtime.connectTimeout=10000;
        return await client.initSmartVerify(request, runtime);
    }

    async function initSmartVerifyAutoRoute(request) {
        const endpoints = [
            "cloudauth.cn-shanghai.aliyuncs.com",
            "cloudauth.cn-beijing.aliyuncs.com"
        ];

        for (const endpoint of endpoints) {
            try {
                const response = await initSmartVerify(endpoint, request);
                if (response.code === '500') {
                    continue;
                }
                return response;
            } catch (err) {
                continue;
            }
        }
        return null;
    }

    async function main(){
        // 通过以下代码创建API请求并设置参数。
        const request = new CloudAuth.InitSmartVerifyRequest({
        // 请输入场景ID。
        sceneId: xxx,
        // 设置商户请求的唯一标识。
        outerOrderNo: "xxx",
        // 模式。
        mode: "OCR",
        // 固定值。
        certType: "IDENTITY_CARD",
        metaInfo: "{\"zimVer\":\"3.0.0\",\"appVersion\": \"1\",\"bioMetaInfo\": \"4.1.0:11501568,0\",\n" +
            "        \"appName\": \"com.aliyun.cloudauth\",\"deviceType\": \"ios\",\"osVersion\": \"iOS 10.3.2\",\"apdidToken\": \"\",\"deviceModel\": \"iPhone9,1\"}",
        // mobile: "130xxxxxxxx",
        // ip: "114.xxx.xxx.xxx",
        // userId: "12345xxxx",
        // callbackUrl: "https://www.aliyundoc.com",
        // callbackToken: "xxxxxxx"
        });

        // 推荐,支持服务路由。
        const response = await initSmartVerifyAutoRoute(request);
        // 不支持服务自动路由。
        //  const response = await initSmartVerify("cloudauth.cn-shanghai.aliyuncs.com", request);

        console.log(response.requestId);
        console.log(response.code);
        console.log(response.message);
        console.log(response.resultObject.certifyId);
        }

main().then(function (response) {});

DescribeSmartVerify接口调用示例

const Config = require("@alicloud/openapi-client");
const CloudAuth = require("@alicloud/cloudauth20200618");
const CloudAuthClient = CloudAuth.default;
const {RuntimeOptions} = require("@alicloud/tea-util");
const { default: Credential } = require('@alicloud/credentials');

     function createClient(endpoint) {
        // 阿里云账号AccessKey拥有所有API的访问权限,建议您使用RAM用户进行API访问或日常运维。
        // 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里,否则可能导致AccessKey泄露,威胁您账号下所有资源的安全。
	      // 本示例通过阿里云Credentials工具从环境变量中读取AccessKey,来实现API访问的身份验证。
        const cred = new Credential();
        const config = new Config.Config({
        credential: cred,
        // 设置Endpoint。
        endpoint: endpoint,
        // 设置HTTP代理。
        // httpProxy: "http://xxx.xxx.xxx.xxx:9999",
        // 设置HTTPS代理。
        // httpsProxy: "https://username:password@xxx.xxx.xxx.xxx:9999",
  });
        return new CloudAuthClient(config)
    }

    async function describeSmartVerify(endpoint, request) {
        const client = createClient(endpoint);
        // 创建RuntimeObject实例并设置运行参数。
        const runtime = new RuntimeOptions([]);
        runtime.readTimeout=10000;
        runtime.connectTimeout=10000;
        return await client.describeSmartVerify(request, runtime);
    }

    async function describeSmartVerifyAutoRoute(request) {
        const endpoints = [
            "cloudauth.cn-shanghai.aliyuncs.com",
            "cloudauth.cn-beijing.aliyuncs.com"
        ];

        for (const endpoint of endpoints) {
            try {
                const response = await describeSmartVerify(endpoint, request);
                if (response.code === '500') {
                    continue;
                }
                return response;
            } catch (err) {
                continue;
            }
        }
        return null;
    }

    async function main(){
        // 通过以下代码创建API请求并设置参数。
        const request = new CloudAuth.DescribeSmartVerifyRequest({
            sceneId: xxx,
            certifyId: "xxx"
        });

        // 推荐,支持服务路由。
        const response = await describeSmartVerifyAutoRoute(request);
        // 不支持服务自动路由。
        //  const response = await describeSmartVerify("cloudauth.cn-shanghai.aliyuncs.com", request);

        console.log(response.requestId);
        console.log(response.code);
        console.log(response.message);
        console.log(response.resultObject.passed);
        console.log(response.resultObject.subCode);
        console.log(response.resultObject.materialInfo);
        console.log(response.resultObject.passedScore);
        }

main().then(function (response) {});