setting alipay wechat success appmanage dollor user cart order workorder logout left1 left2 app unfree free chart coupon note copy pencil price-tag database cog bin list link plus minus codepen 审核 cross table search user-tie eye github cancel-circle checkmark icon-upload icon-smartphon icon-auth-user icon-arroba-symbol icon-check-pass icon-red-cross icon-pwd-key icon-used icon-expired android appleinc tux windows8 java webAPI mail vip

    # 静默活体检测sensetime API 文档

    # 接口说明

    基于商汤的活体检测技术,将一段实地拍摄的人脸视频进行云端检测,判断是否为真人活体,该接口用于对一段短视频进行静默活体检测,判断视频中人脸是否为活体。

    该能力是通过HTTP API的方式给开发者提供一个通用的接口,适用于一次性交互数据传输的AI服务场景,块式传输。相较于SDK,API具有轻量、跨语言的特点,不过请注意该接口使用的HTTP API协议不支持跨域。

    # 接口Demo

    示例demo请点击 这里 下载。
    目前仅提供部分开发语言的demo,其他语言请参照下方接口文档进行开发。
    也欢迎热心的开发者到 讯飞开放平台社区 (opens new window) 分享你们的demo。

    # 接口要求

    集成静默活体检测API时,需按照以下要求。

    内容 说明
    请求协议 http[s] (为提高安全性,强烈推荐https)
    请求地址 http[s]: //api.xfyun.cn/v1/service/v1/image_identify/silent_detection
    注:服务器IP不固定,为保证您的接口稳定,请勿通过指定IP的方式调用接口,使用域名方式调用
    请求方式 POST
    接口鉴权 签名机制,见授权认证
    字符编码 UTF-8
    响应格式 统一采用JSON格式
    开发语言 任意,只要可以向讯飞云服务发起HTTP请求的均可
    适用范围 任意操作系统,但因不支持跨域不适用于浏览器,请在后端调用接口
    视频格式 包括且不限于.mp4,.avi,.flv,.wmv,.mov,.rm,建议使用mp4
    视频长度 建议不小于3秒
    视频大小 视频数据按要求编码后(base64编码后进行urlencode)大小不超过20M

    # 接口调用流程

    注: 若需配置IP白名单,请前往控制台。IP白名单规则请参照 IP白名单

    1. 通过接口密钥基于MD5计算签名,将签名以及其他参数放在Http Request Header中,详见下方 请求头
    2. 将视频数据放在Http Request Body中,以POST表单的形式提交,详见下方 请求体
    3. 向服务器端发送Http请求后,接收服务器端的返回结果,返回结果详见各接口的详细说明。

    接口地址示例:

    	POST http[s]://api.xfyun.cn/v1/service/v1/image_identify/silent_detection HTTP/1.1
    	Content-Type:application/x-www-form-urlencoded; charset=utf-8
    

    # 白名单

    在调用该业务接口时

    • 若关闭IP白名单,接口认为IP不限,不会校验IP。
    • 若打开IP白名单,则服务端会检查调用方IP是否在讯飞开放平台配置的IP白名单中,对于没有配置到白名单中的IP发来的请求,服务端会拒绝服务。

    IP白名单规则

    • IP白名单,在 控制台-我的应用-相应服务的应用管理卡片上 编辑,保存后五分钟左右生效;
    • 不同Appid的不同服务都需要分别设置IP白名单;
    • IP白名单需设置为外网IP,请勿设置局域网IP;
    • 如果服务器返回结果如下所示(illegal client_ip),则表示由于未配置IP白名单或配置有误,服务端拒绝服务。
    {
        "code":"10105",
        "desc":"illegal access|illegal client_ip",
        "data":"",
        "sid":"xxxxxx"
    }
    

    # 接口请求参数

    # 请求头

    Http Request Header 中配置以下参数。

    # 授权认证

    以下参数用于授权认证:

    参数 格式 说明 必须
    X-Appid string 讯飞开放平台注册申请应用的应用ID(appid)
    X-CurTime string 当前UTC时间戳
    从1970年1月1日0点0 分0 秒开始到现在的秒数
    X-Param string 相关参数JSON串经Base64编码后的字符串,详见业务参数
    X-CheckSum string 令牌,计算方法:MD5(APIKey + X-CurTime + X-Param),三个值拼接的字符串,进行MD5哈希计算(32位小写)

    注:

    • APIKey:接口密钥,在讯飞开放平台控制台添加相应服务后即可获取,调用方注意保管,如泄露,可到控制台提交工单联系技术人员重置;
    • X-CheckSum 有效期:出于安全性考虑,每个 X-CheckSum 的有效期为 5 分钟(用 X-CurTime 计算),同时 X-CurTime 要与标准时间同步,否则时间相差太大,服务端会直接认为 X-CurTime 无效;
    • BASE64 编码采用 MIME 格式,字符包括大小写字母各26个,加上10个数字,和加号 + ,斜杠 / ,一共64个字符。

    *X-CheckSum *生成示例:

    String APIKey="abcd1234"; 
    String X-CurTime="1502607694";
    String X-Param="eyAiYXVmIjogImF1ZGlvL0wxNjtyYXR...";
    String X-CheckSum=MD5(apiKey + X-CurTime + X-Param);
    

    # 业务参数

    X-Param 为各配置参数组成的 JSON 串经 BASE64 编码之后的字符串,原始 JSON 串各字段说明如下:

    参数 类型 必须 说明 示例
    get_image bool 是否返回base64视频图片。默认值为false,不返回;值为true时,返回 true

    X-Param生成示例:

    	原始JSON串:
    	{
    	    "get_image": True,
    	}
    	BASE64编码(即X-Param):
    	eyJnZXRfaW1hZ2UiOiB0cnVlfQ==
    

    # 请求体

    以POST表单的形式提交以下参数:

    参数 类型 必须 说明
    file string 待检测视频,为了保证效果建议视频长度不小于3秒,需要base64编码后进行urlencode,格式包括且不限于.mp4,.avi,.flv,.wmv,.mov,.rm,要求编码后视频大小不超过10M,建议mp4

    注:
    一般基础类库会默认进行urlencode处理,请注意不要重复处理。

    # 接口返回参数

    返回值为 json 串,各字段如下:

    参数 类型 说明
    code string 结果码(具体见SDK&API错误码查询 (opens new window))
    data float 检测结果
    desc string 描述
    sid string 会话ID

    其中 sid 字段主要用于追查问题,如果出现问题,可以提供 sid 给讯飞技术人员帮助确认问题。

    data中结果字段解释说明:

    参数 类型 说明
    passed bool 是否通过活体检测
    liveness_score float 静默活体检测得分
    image_timestamp float 视频选帧时间戳
    base64_image string base64编码后的图片文件流(可选,默认不返回)

    注意

    1、如果活体检测不通过,即'passed'为false,image_timestamp和base64_image字段将无意义;

    2、活体检测通过情况下,base64_image是否返回由输入参数get_image控制;

    3、liveness_score字段为保留字段,返回值不具备参考价值,实际活体检测结果以passed字段值为准。


    结果示例如下:

    失败结果:

        {
            "code": "10106",
            "desc": "invalid parameter|invalid X-Appid",
            "data": 0,
            "sid": "wsr0000bb3f@ch3d5c059d83b3477200"
        }
    

    成功结果:

    	{
        "data":{
            "passed":true,
            "liveness_score":0.96,
            "image_timestamp":1534747248,
            "base64_image":""
        },
        "code":"0",
        "desc":"success",
        "sid":"wsr00000001@ch36940e324c59000100"
    	}
    

    # 调用示例

    静默活体检测demo go语言 (opens new window)

    静默活体检测demo php语言 (opens new window)

    静默活体检测demo java语言 (opens new window)

    静默活体检测demo python3语言 (opens new window)

    静默活体检测demo c#语言 (opens new window)

    # 常见问题

    # 静默活体检测主要功能是什么?

    答:将一段实地拍摄的人脸视频进行云端检测,判断是否为真人活体并给出分值参考。

    # 静默活体检测对上传的人脸视频有什么要求?

    答:(1)支持mp4, .avi, .flv, .wmv, .mov, .rm格式视频,建议上传MP4格式; (2)视频大小不应超过16M。

    # 静默活体检测支持什么应用平台?

    答:支持Web api应用平台。

    # 静默活体检测可以免费使用吗?

    答:可以的,登录讯飞开放平台,进入静默活体检测页面,点击“服务管理”,创建应用,可免费使用500次,授权期限为1个月。

    # 静默活体检测是支持对活体的识别吗?

    答:静默活体检测支持动态活体判断功能,将一段实地拍摄的人脸视频进行云端检测,判断是否为真人活体并给出分值参考。

    # 静默活体检测服务量怎么购买?

    答:控制台对应静默活体检测服务--->实时用量--->点击购买服务量,填好相关信息,商务工作人员会及时与您联系。