通行验证 - 面板机

请求参数

Header 参数

AppId

string

可选

对接api的应用id

默认值:

abc123

Timestamp

string

时间戳(毫秒)

可选

默认值:

1699262829777

ReqId

string

请求id

可选

默认值:

12345678901

Sign

string

可选

请求签名,签名规则参考接口说明文档

默认值:

092dd47f46ddfb3815093b8d631bc462

Body 参数application/json

sid

string

会话id

必需

vid

string

核验id

必需

voucherType

integer

核验凭证类型（身份证号/二维码/ic卡）

必需

0：身份证，1：二维码，2：IC卡

voucher

string

核验凭证

必需

devNo

string

设备编码

必需

示例

{
    "sid": "string",
    "vid": "string",
    "voucherType": 0,
    "voucher": "string",
    "devNo": "string"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/device/access/valid' \
--header 'AppId: abc123' \
--header 'Timestamp: 1699262829777' \
--header 'ReqId: 12345678901' \
--header 'Sign: 092dd47f46ddfb3815093b8d631bc462' \
--header 'Content-Type: application/json' \
--data-raw '{
    "sid": "string",
    "vid": "string",
    "voucherType": 0,
    "voucher": "string",
    "devNo": "string"
}'

返回响应

🟢200成功

application/json

Body

code

integer

错误码

必需

0成功, -1鉴权失败,其他值根据业务定义

data

object

业务内容

可选

sid

string

会话id

必需

vid

string

核验id

必需

pass

boolean

是否允许通行

必需

code

integer

状态码

必需

0成功，-1失败

msg

string

状态信息

可选

如查询不到凭证信息、重复核验等

voucherType

integer

核验凭证类型

必需

voucher

string

核验凭证

必需

voucherPerson

string

凭证对应人员信息

可选

如脱敏姓名张*、脱敏身份证号7113966****6295

voucherMsg

string

凭证对应具体信息

可选

如xx景区成人票

passesNum

integer

通行人数

可选

多次通行使用

voiceMsg

string

语音播报信息

可选

autoFaceReg

boolean

自动注册人脸

可选

设备开启人证核验的情况下可按需自动注册身份证人脸照到平台

effectTime

string

自动注册人员生效时间

可选

无该字段或空默认立即生效，格式：yyyy-MM-dd HH:mm:ss

expireTime

string

自动注册人员过期时间

可选

无该字段或空默认永久有效，格式：yyyy-MM-dd HH:mm:ss

示例

成功示例鉴权失败等非业务相关异常示例业务相关异常示例

{
    "code": 0,
    "data": {
        "sid": "1111",
        "vid": "2222",
        "pass": true,
        "code": 0,
        "msg": "ok",
        "voucherType": 0,
        "voucher": "711396200001016295",
        "voucherPerson": "711396********6295",
        "voucherMsg": "xx景区xx成人票",
        "passesNum": 2,
        "voiceMsg": "成人票"
    }
}