人脸照片比对

传入两张人脸照片,进行比对,返回相似度,验证两张人脸照片是否为同一人,常用图片格式都支持,建议图片大小不超过1M,保证五官清晰可见。支持多种图片格式,识别准确率超过99%,更快、更精准。

  • 企业实名
  • 低延迟
  • 免费试用 5 次

个人用户无法使用该接口,需完成企业认证

官网购买的套餐通过API调用时请使用“扣套餐次数”密钥进行调用

请求地址

POSThttps://api.shuxuntech.com/v1/faceCompare/check

  • x-www-form-urlencoded
  • 200ms
  • 99.9%

¥0.022元 / 次

阶梯计价,用量越大单价越低

企业认证后额外赠送 666 次调用额度

01 — 接口说明

请求参数与返回结果

所有请求需在 header 中携带签名信息,body 参数按 x-www-form-urlencoded 提交

名称位置类型必填说明
appKeyheadstring是数勋分配appKey
timestampheadstring是unix时间毫秒值
signheadstring是签名,说明
image1bodystring否第一张人脸照片base64,不超过1mb
imgUrl1bodystring否第一张人脸图片url,不超过1mb
image2bodystring否第二张人脸照片base64,不超过1mb
imgUrl2bodystring否第二张人脸图片url,不超过1mb

签名算法说明

数勋分配的appKey、当前unix时间毫秒值timestamp、数勋分配的appSecret、 按顺序拼接sha256加密得到sign,查看如下示例

appKey = aaa;timestamp = 1682476904289;appSecret = bbb;sign = sha256(appKey+timestamp+appSecret)

02 — 返回说明

返回结构与字段含义

顶层返回 code 与 msg,业务数据在 data 对象内,各字段含义见下方表格

返回字段描述

字段名类型描述
codestring错误码
msgstring错误描述
isFeeint是否计费(1:计费,0:不计费)
seqNostring调用流水号
dataobject返回数据

data对象说明

字段名类型描述
resultint比对结果
resultDescstring比对结果描述
confidencedouble置信度分数
thresholdobject置信度阈值

result比对结果说明

字段名类型描述
1比对成功,有数据
2比对成功,无数据
3比对失败,无法正确解析、未按要求传入参数、下载图片超时

threshold置信度阈值说明

字段名类型描述
threshold1一级
threshold2二级,建议分数超过二级则可判定为是同一人
threshold3三级

code错误码说明

code说明
0成功
1参数错误
2无记录
3第三方服务异常
4签名错误
5余额不足
6调用频率超限
7账号停用
8接口已停用
9联系服务商开通接口权限
10ip不在白名单
11系统异常
12实名状态错误
99其他异常,具体返回为准

返回示例

正确返回

{    "code": "0",    "msg": "成功",    "isFee": 1,    "seqNo": "9hi5fht958638y0egkjpo8udjs76vgwx",    "data": {        "result": 1,        "resultDesc": "比对成功,有数据",        "confidence": 97.389,        "threshold": {            "threshold1": 62.327,            "threshold2": 69.101,            "threshold3": 73.975        }    }}

错误返回

{    "code": "1",    "msg": "必须上传2张人脸照片",    "isFee": 0,    "seqNo": null,    "data": null}

03 — 代码示例

七种语言,复制即用

签名规则:sha256(appKey + timestamp + appSecret),下列示例已包含完整签名流程

FaceCompareDemo.java
import java.io.BufferedReader;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;
import java.net.URLEncoder;
import java.security.MessageDigest;

/**
 * 人脸比对 - Java 示例代码
 * 接口地址:https://api.shuxuntech.com/v1/faceCompare/check
 *
 * 说明:本示例只使用 JDK 原生 API(java.net / java.security),不依赖任何第三方 jar 包,
 *      也不需要本项目的工具类,复制到本地即可编译运行:
 *          javac FaceCompareDemo.java
 *          java FaceCompareDemo
 */
public class FaceCompareDemo {

    /** 数勋分配的 appKey,请替换为您自己的 appKey */
    private static final String APP_KEY = "您的appKey";
    /** 数勋分配的 appSecret,请替换为您自己的 appSecret */
    private static final String APP_SECRET = "您的appSecret";
    /** 接口地址 */
    private static final String API_URL = "https://api.shuxuntech.com/v1/faceCompare/check";
    /** 图片1 base64 */
    private static final String IMAGE1 = "";
    /** 图片1 url */
    private static final String IMG_URL1 = "";
    /** 图片2 base64 */
    private static final String IMAGE2 = "";
    /** 图片2 url */
    private static final String IMG_URL2 = "";

    public static void main(String[] args) throws Exception {
        // 1、当前 unix 时间毫秒值,服务端要求与服务器时间相差不能超过 5 分钟
        String timestamp = String.valueOf(System.currentTimeMillis());

        // 2、签名:按顺序拼接 appKey + timestamp + appSecret 后做 sha256,得到小写十六进制字符串
        String sign = sha256Hex(APP_KEY + timestamp + APP_SECRET);

        // 3、业务参数,拼成表单内容
        String body = "image1=" + urlEncode(IMAGE1) + "&" + "imgUrl1=" + urlEncode(IMG_URL1) + "&" + "image2=" + urlEncode(IMAGE2) + "&" + "imgUrl2=" + urlEncode(IMG_URL2);

        // 4、发起 POST 请求,appKey、timestamp、sign 放在请求头
        HttpURLConnection conn = (HttpURLConnection) new URL(API_URL).openConnection();
        conn.setRequestMethod("POST");
        conn.setDoOutput(true);
        conn.setRequestProperty("Content-Type", "application/x-www-form-urlencoded; charset=UTF-8");
        conn.setRequestProperty("appKey", APP_KEY);
        conn.setRequestProperty("timestamp", timestamp);
        conn.setRequestProperty("sign", sign);
        conn.setConnectTimeout(10000);
        conn.setReadTimeout(20000);
        conn.getOutputStream().write(body.getBytes("UTF-8"));

        int status = conn.getResponseCode();
        // 5、读取返回内容:报错时读错误流,避免只拿到一个异常看不到原因
        InputStream in = (status >= 200 && status < 300) ? conn.getInputStream() : conn.getErrorStream();
        String result = readAll(in);
        conn.disconnect();

        System.out.println("HTTP状态码=" + status);
        System.out.println("返回结果=" + result);
    }

    /**
     * sha256 加密,返回小写十六进制字符串
     * 服务端校验签名用的就是这个算法(小写十六进制)
     */
    private static String sha256Hex(String content) throws Exception {
        byte[] bytes = MessageDigest.getInstance("SHA-256").digest(content.getBytes("UTF-8"));
        StringBuilder sb = new StringBuilder(bytes.length * 2);
        for (byte b : bytes) {
            sb.append(Character.forDigit((b >> 4) & 0xF, 16));
            sb.append(Character.forDigit(b & 0xF, 16));
        }
        return sb.toString();
    }

    /** url 编码,中文参数需要编码 */
    private static String urlEncode(String value) throws Exception {
        return URLEncoder.encode(value, "UTF-8");
    }

    /** 读取输入流内容 */
    private static String readAll(InputStream in) throws Exception {
        if (in == null) {
            return "";
        }
        StringBuilder sb = new StringBuilder();
        BufferedReader reader = new BufferedReader(new InputStreamReader(in, "UTF-8"));
        try {
            String line;
            while ((line = reader.readLine()) != null) {
                sb.append(line);
            }
        } finally {
            reader.close();
        }
        return sb.toString();
    }
}

04 — 在线调试

先调通,再决定

用你自己的数据发一次真实请求,表单字段随接口定义自动生成,返回结果附字段注释

POSThttps://api.shuxuntech.com/v1/faceCompare/check按次计费 · 优先扣套餐次数

请求参数

按接口定义自动生成

  • image1第一张人脸照片base64,不超过1mb
  • imgUrl1第一张人脸图片url,不超过1mb
  • image2第二张人脸照片base64,不超过1mb
  • imgUrl2第二张人脸图片url,不超过1mb

appKey / timestamp / sign调用时自动按 sha256 生成,无需手填

appKey=未获取 · timestamp=实时生成 · sign=自动生成

这是真实调用,会消耗套餐次数或账户余额; 请勿用真实证件信息反复试调

调不通时先看这里错误码与返回字段的完整说明见上方「02 — 返回说明」;签名口径与「03 — 代码示例」完全一致,可直接复制使用。

返回结果

点击左侧「提交并调用接口」,参数会就地组装、按文档口径签名后直接请求接口, 返回的 JSON 显示在这里。
在线调试使用你自己的 appKey,按实际调用计费。

返回结果是纯 JSON,字段含义见上方「02 — 返回说明」字段类型与取值说明以「02 — 返回说明」的字段表为准;错误码的完整定义同样在那一节。

05 — 产品价格

阶梯计价,用多少买多少

单次价格随调用量阶梯下降,大档位单价最低

调用量价格单价
5 次¥ 0¥ 0
300 次¥ 12¥ 0.04
1,000 次¥ 28¥ 0.028
5,000 次¥ 135¥ 0.027
10,000 次¥ 260¥ 0.026
50,000 次¥ 1,200¥ 0.024
100,000 次¥ 2,200¥ 0.022