文档

Node.js SDK调用示例

更新时间:

本文介绍了金融级实人认证纯服务端API的Node.js SDK调用示例。

SDK使用说明

如果需要其他语言的SDK示例代码,您可以通过OpenAPI 开发者门户在线调试工具调试API接口,该工具会自动生成相应API的SDK调用示例代码。您可以单击以下接口链接进行调试:

调试ContrastFaceVerify接口

前提条件

  • 需要使用的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/cloudauth20190307@2.0.3
npm install @alicloud/credentials
说明

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

照片实人认证调用示例

关于参数的具体描述,请参见照片实人认证

const Config = require("@alicloud/openapi-client");
const CloudAuth = require("@alicloud/cloudauth20190307");
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 contrastFaceVerify(endpoint, request) {
    const client = createClient(endpoint);
    // 创建RuntimeObject实例并设置运行参数。
    const runtime = new RuntimeOptions([]);
    runtime.readTimeout=10000;
    runtime.connectTimeout=10000;
    return await client.contrastFaceVerifyWithOptions(request, runtime);
}

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

    for (const endpoint of endpoints) {
        try {
            const response = await contrastFaceVerify(endpoint, request);
            if (response.statusCode === 500) {
                continue;
            }
            if(response.body !== null){
                if(response.body.code === "500"){
                    continue;
                }
            }
            return response;
        } catch (err) {
            console.log(err);
            continue;
        }
    }
    return null;
}

async function main(){
    // 通过以下代码创建API请求并设置参数。
    const request = new CloudAuth.ContrastFaceVerifyRequest({
        // 请输入场景ID。
        sceneId: 0,
        // 设置商户请求的唯一标识。
        outerOrderNo: "xxx",
        // 要接入的认证方案。
        productCode: "ID_MIN",
        // 模式。
        model: "NO_LIVENESS",
        // 固定值。
        certType: "IDENTITY_CARD",
        certName: "张三",
        certNo: "xxx",
        // mobile: "130xxxxxxxx",

        // 请在以下四种方式中选择其一。
        // 1.人脸图片的Base64编码。
        // 2.已授权OSS空间的Bucket名和已授权OSS空间的文件名。
        // 3.人脸图片的HTTPS或HTTP地址。
        // 4.已通过智能核身得到的CertifyId,认证时的图片作为比对图片。

        // 方式一:人脸图片的Base64编码。
        // faceContrastPicture: "/9j/4AAQSkZJRgABAQAASxxxxxxx",
        // 方式二:已授权OSS空间的Bucket名和已授权OSS空间的文件名。
        // ossBucketName: "cn-shanghai-aliyun-cloudauth-xxxxx",
        // ossObjectName: "verify/xxxxx/xxxxxx.jpeg",
        //方式三:人脸图片的HTTPS或HTTP地址。
        faceContrastPictureUrl: "https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/smart/xxxxx/xxxxx.jpeg",
        // 方式四:已通过智能核身得到的CertifyId,认证时的图片作为比对图片。
        // certifyId: "0bfa7c493f850e5178b9f8613634c9xx",

        // ip: "114.xxx.xxx.xxx",
        // userId: "12345xxxx",
        // deviceToken: "xxxxxxx",

        // 如需开启个人信息加密传输。
        // encryptType: "SM2",
        // certName: "BCRD/7ZkNy7Q*****M1BMBezZe8GaYHrLwyJv558w==",
        // certNo: "BMjsstxK3S4b1YH*****Pet8ECObfxmLN92SLsNg=="
    });

    // 推荐,支持服务路由。
    const response = await contrastFaceVerifyAutoRoute(request);
    // 不支持服务自动路由。
    // const response = await contrastFaceVerify("cloudauth.cn-shanghai.aliyuncs.com", request);
   if (response){
    console.log(response.body.requestId);
    console.log(response.body.code);
    console.log(response.body.message);
    console.log(response.body.resultObject.certifyId);
    }
}

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

视频实人认证调用示例

支持OSS对象存储方式和本地文件两种方式。关于参数的具体描述,请参见视频实人认证

使用本地文件的方式(推荐)

const Config = require("@alicloud/openapi-client");
const CloudAuth = require("@alicloud/cloudauth20190307");
const CloudAuthClient = CloudAuth.default;
const {RuntimeOptions} = require("@alicloud/tea-util");
const fs = require("fs");
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 contrastFaceVerify(endpoint, request) {
    const client = createClient(endpoint);
    // 创建RuntimeObject实例并设置运行参数。
    const runtime = new RuntimeOptions([]);
    runtime.readTimeout=10000;
    runtime.connectTimeout=10000;
    return await client.contrastFaceVerifyAdvance(request, runtime);
}

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

    for (const endpoint of endpoints) {
        try {
            const response = await contrastFaceVerify(endpoint, request);
            if (response.statusCode === 500) {
                continue;
            }
            if(response.body !== null){
                if(response.body.code === "500"){
                    continue;
                }
            }
            return response;
        } catch (err) {
            console.log(err);
            continue;
        }
    }
    return null;
}

async function main(){
    const fileStream = fs.createReadStream("本地文件路径");
    // 通过以下代码创建API请求并设置参数。
    const request = new CloudAuth.ContrastFaceVerifyAdvanceRequest({
        // 请输入场景ID。
        sceneId: xxx,
        // 设置商户请求的唯一标识。
        outerOrderNo: "xxx",
        // 要接入的认证方案。
        productCode: "ID_MIN_VIDEO",
        // 模式。
        model: "FRONT_CAMERA_LIVENESS",
        // 固定值。
        certType: "IDENTITY_CARD",
        certName: "张三",
        certNo: "xxx",
        faceContrastFileObject: fileStream

        // mobile: "130xxxxxxxx",
        // ip: "114.xxx.xxx.xxx",
        // userId: "12345xxxx",
        // deviceToken: "xxxxxxx",
        // 如需开启个人信息加密传输。
        // encryptType: "SM2",
        // certName: "BCRD/7ZkNy7Q*****M1BMBezZe8GaYHrLwyJv558w==",
        // certNo: "BMjsstxK3S4b1YH*****Pet8ECObfxmLN92SLsNg=="
    });

    // 推荐,支持服务路由。
    const response = await contrastFaceVerifyAutoRoute(request);
    // 不支持服务自动路由。
    // const response = await contrastFaceVerify("cloudauth.cn-shanghai.aliyuncs.com", request);
    if (response){
    console.log(response.body.requestId);
    console.log(response.body.code);
    console.log(response.body.message);
    console.log(response.body.resultObject.certifyId);
    }
    fileStream.close();
}

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

使用OSS对象存储的方式

const Config = require("@alicloud/openapi-client");
const CloudAuth = require("@alicloud/cloudauth20190307");
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 contrastFaceVerify(endpoint, request) {
    const client = createClient(endpoint);
    // 创建RuntimeObject实例并设置运行参数。
    const runtime = new RuntimeOptions([]);
    runtime.readTimeout=10000;
    runtime.connectTimeout=10000;
    return await client.contrastFaceVerifyWithOptions(request, runtime);
}

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

    for (const endpoint of endpoints) {
        try {
            const response = await contrastFaceVerify(endpoint, request);
            if (response.statusCode === 500) {
                continue;
            }
            if(response.body !== null){
                if(response.body.code === "500"){
                    continue;
                }
            }
            return response;
        } catch (err) {
            console.log(err);
            continue;
        }
    }
    return null;
}

async function main(){
    // 通过以下代码创建API请求并设置参数。
    const request = new CloudAuth.ContrastFaceVerifyRequest({
        // 请输入场景ID。
        sceneId: xxx,
        // 设置商户请求的唯一标识。
        outerOrderNo: "xxx",
        // 要接入的认证方案。
        productCode: "ID_MIN_VIDEO",
        // 模式。
        model: "FRONT_CAMERA_LIVENESS",
        // 固定值。
        certType: "IDENTITY_CARD",
        certName: "张三",
        certNo: "xxx",
        ossBucketName: "cn-shanghai-aliyun-cloudauth-xxxxx",
        ossObjectName: "verify/xxxxx/xxxxxx.mp4",

        // mobile: "130xxxxxxxx",
        // ip: "114.xxx.xxx.xxx",
        // userId: "12345xxxx",
        // deviceToken: "xxxxxxx",

        // 如需开启个人信息加密传输。
        // encryptType: "SM2",
        // certName: "BCRD/7ZkNy7Q*****M1BMBezZe8GaYHrLwyJv558w==",
        // certNo: "BMjsstxK3S4b1YH*****Pet8ECObfxmLN92SLsNg=="
    });

    // 推荐,支持服务路由。
    const response = await contrastFaceVerifyAutoRoute(request);
    // 不支持服务自动路由。
    // const response = await contrastFaceVerify("cloudauth.cn-shanghai.aliyuncs.com", request);
    if (response){
    console.log(response.body.requestId);
    console.log(response.body.code);
    console.log(response.body.message);
    console.log(response.body.resultObject.certifyId);
}
}

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