PSB 人证核验开放 API

本文介绍人证信息同步南向接口功能.为适应市场不同端的使用需求, 开放面向人证机厂商、面向终端自助机、面向终端纯人证机场景的API. 下面将从每种场景开始介绍.

面向三方人证厂商场景

当前方案主要适合于三方厂商云云对接场景. 通过涂鸦做人证数据推送.或适用于人脸通行方案.

对接方式

方案针对大型三方人证厂商. 其中hotel_code为酒店Saas绑定Psb申请提交时的绑定码. 用于云云对接中做标识唯一对接.

提供平台logo、平台名称、tuya开放平台云项目clientId等信息联系商务

人证数据推送

接口描述

当 PSB 系统有客户核验人证信息，则将人证信息同步至智慧酒店公寓平台。

接口地址

POST /v1.0/iot-02/psb/identity-auth-infos

请求参数

参数名	类型	参数类型	描述	是否必填
hotel_code	String	BODY	涂鸦提供门店的唯一标识	是
id_card_type	String	BODY	证件类型。 SFZ：身份证 WAIGUOREN：外国人居留证 HKMOJUMIN：港澳台居住证	是
id_card_no	String	BODY	身份证	是
spot_picture_url	String	BODY	现场照片	是
auth_result	Boolean	BODY	认证结果	是
name	String	BODY	身份证姓名	是
id_card_picture_url	String	BODY	身份证照片	否
gender	String	BODY	性别。 0：女 1：男	否
ethnicity	String	BODY	民族	否
address	String	BODY	户籍地址	否
birth_date	Long	BODY	出生日期，13 位时间戳	否
expire_start	Long	BODY	身份证有效起始日期，13 位时间戳	否
expire_end	Long	BODY	身份证有效截止日期，13 位时间戳	否

请求示例

POST  {url}/v1.0/iot-02/psb/identity-auth-infos

{
    "hotel_code": "2703xxxxxxxx123",
    "id_card_type": "SFZ",
    "id_card_no": "440183199631031322",
    "spot_picture_url": "https://xxxxxxxsaf",
    "auth_result": true,
    "birth_date": 1565589600000,
    "name": "张xx",
    "gender": 1
}

响应成功示例

{
  "success": true,
  "result": true,
  "t": 1566053034624
}

响应失败示例

{
 "code":500,
    "msg":"System error, please contact the admin",
    "success":false,
    "t":1561378856383
}

面向终端自助机场景

该场景主要面向酒店自助机场景. 其中sn为自助机唯一标识、brandCode由涂鸦分配. 与人证机或云云对接方案不同点为需要入住单、住客手机号、房间号等. 可以更精确匹配到酒店PMS订单. 提供友好的客控服务

对接方式:

提供平台logo、平台名称、自助机终端型号、tuya开放平台云项目clientId等信息联系商务

自助机人证数据推送

接口描述

自助机将人证信息同步至智慧酒店公寓平台。

接口地址

POST /v2.0/iot-02/psb/identity-auth-infos

请求参数

参数名	类型	参数类型	描述	是否必填
sn	String	BODY	设备唯一编码	是
brand_code	String	BODY	品牌商 code	是
checkin_id	String	BODY	入住单 ID	是
phone_no	String	BODY	手机号	是
room_no	String	BODY	房间号	是
already_push_psb	Boolean	BODY	是否已经推送到 PSB。 true：已推送 false：未推送	是
spot_picture_url	String	BODY	现场照片 URL	是
id_card_picture_url	String	BODY	身份证照片 URL	否
id_card_type	String	BODY	证件类型。 SFZ：身份证 WAIGUOREN：外国人居留证 HKMOJUMIN：港澳台居住证	是
id_card_no	String	BODY	身份证	是
auth_result	Boolean	BODY	认证结果。 true：验证成功 false：验证失败	是
name	String	BODY	身份证姓名	是
gender	String	BODY	性别。 0：女 1：男 2：未知	否
ethnicity	String	BODY	民族	否
address	String	BODY	户籍地址	否
birth_date	Long	BODY	出生日期，13 位时间戳	否
expire_start	Long	BODY	身份证有效起始日期，13 位时间戳	否
expire_end	Long	BODY	身份证有效截止日期，13 位时间戳	否
issuing_authority	String	BODY	签发机关	否

请求示例

POST  {url}/v2.0/iot-02/psb/identity-auth-infos

{
    "sn":"xxx",
    "brand_code":"xxx",
    "checkin_id":"xx",
    "phone_no":"xx",
    "room_no":"xx",
    "already_push_psb":true,
    "spot_picture_url":"xxx",
    "id_card_picture_url":"xxx",
    "id_card_type":"SFZ",
    "id_card_no":"xxx",
    "auth_result":true,
    "name":"xx",
    "gender":1,
    "ethnicity":"xx",
    "address":"xxx",
    "birth_date":1111,
    "expire_start":222,
    "expire_end":333,
    "issuing_authority":"xx"
}

响应成功示例

{
  "success": true,
  "result": true,
  "t": 1566053034624
}

响应失败示例

{
 "code":500,
    "msg":"System error, please contact the admin",
    "success":false,
    "t":1561378856383
}

面向终端纯人证机场景(敬请期待)

该方式主要覆盖酒店纯人证机场景. 提供对人证机在酒店Saas进行绑定后, 即可推送人证信息到涂鸦酒店, 同时涂鸦酒店Saas会进行自动核验, 或核验失败后需要进行手工在Saas内操作. 为该场景客户提供少一次操作的体验.

对接方式:

提供平台logo、平台名称、自助机终端型号、tuya开放平台云项目clientId等信息联系商务

人证机人证数据推送

接口描述

自助机将人证信息同步至智慧酒店公寓平台。

接口地址

POST /v3.0/cloud/hotel/psb/identity-auth-infos

请求参数

参数名	类型	参数类型	描述	是否必填
sn	String	BODY	设备唯一编码	是
brand_code	String	BODY	品牌商 code	是
already_push_psb	Boolean	BODY	是否已经推送到 PSB。 true：已推送 false：未推送	是
spot_picture_url	String	BODY	现场照片 URL	是
id_card_picture_url	String	BODY	身份证照片 URL	否
id_card_type	String	BODY	证件类型。 SFZ：身份证 WAIGUOREN：外国人居留证 HKMOJUMIN：港澳台居住证	是
id_card_no	String	BODY	身份证	是
auth_result	Boolean	BODY	认证结果。 true：验证成功 false：验证失败	是
name	String	BODY	身份证姓名	是
gender	String	BODY	性别。 0：女 1：男 2：未知	否
ethnicity	String	BODY	民族	是
address	String	BODY	户籍地址	是
birth_date	Long	BODY	出生日期，13 位时间戳	否
expire_start	Long	BODY	身份证有效起始日期，13 位时间戳	是
expire_end	Long	BODY	身份证有效截止日期，13 位时间戳	是
issuing_authority	String	BODY	签发机关	否

请求示例

POST  {url}/v3.0/cloud/hotel/psb/identity-auth-infos

{
    "sn":"xxx",
    "brand_code":"xxx",
    "already_push_psb":true,
    "spot_picture_url":"xxx",
    "id_card_picture_url":"xxx",
    "id_card_type":"SFZ",
    "id_card_no":"xxx",
    "auth_result":true,
    "name":"xx",
    "gender":1,
    "ethnicity":"xx",
    "address":"xxx",
    "birth_date":1111,
    "expire_start":222,
    "expire_end":333,
    "issuing_authority":"xx"
}

响应成功示例

{
  "success": true,
  "result": true,
  "t": 1566053034624
}

响应失败示例

{
 "code":500,
    "msg":"System error, please contact the admin",
    "success":false,
    "t":1561378856383
}

附录

联调环境

• 涂鸦智能平台正式环境域名
• 中国区正式环境
• 美国区正式环境
• 欧洲区正式环境

人脸照片评分

接口描述

根据人脸照片路径，获取人脸照片分数。

接口地址

GET /v1.0/hotel/pms/face/picture/score

请求参数

请求参数	类型	必填	描述	参数类型
face_picture_url	String	是	人脸照片 URL 路径	URL

响应参数

参数名	类型	说明
code	Integer	响应码，成功为空
success	Boolean	是否成功。 true：成功 false：失败
msg	String	异常信息，成功为空
result	Object	结果集

result参数说明

参数名	类型	说明
score	Integer	照片评分
pass	Boolean	是否通过

请求示例

GET {url}/v1.0/pms/face/picture/score?face_picture_url=http://www.xxx.com/picture.jpeg

响应成功示例

{
    "success":true,
    "result": {
        "score":80,
        "pass":true
    }
    "t":1566053034624,
}

响应失败示例

{
    "code":500,
    "msg":"System error, please contact the admin",
    "success":false,
    "t":1561378856383
}