网络发卡

网路发卡器是酒店租住行业解决方案里的硬件产品之一，目前很多酒店有PMS系统和网络发卡系统两套系统，对于酒店租住Paas系统, 体现涂鸦硬件与软件生态一体化, 平台开发者可以使用指定硬件与Paas接口轻易实现网络发卡,门锁卡片管理,发卡器管理等核心能力.

术语

术语	解释
发卡器	发卡器是对卡进行读写操作的工具，可以进行读卡、写卡、授权、格式化等操作。
卡片	存在各种功能卡，如楼栋卡、单元卡、楼层卡等，卡片存在多个扇区，每个扇区会按照约定的协议写入
网络发卡	指的是通过在线方式发卡，是相对离线版本发卡而言

硬件推荐方案

API列表

请求方式	API	描述
POST	/v1.0/osaas/projects/{project_id}/card-issue-devices/card-issuer/{device_id}/card-info-write	发卡器制卡,给发卡器设备发送制卡指令(根据生效时间与失效时间,对发卡器下发制卡指令,生成卡片信息)
POST	/v1.0/osaas/projects/{project_id}/card-issue-devices/card-issuer/{device_id}/card-info-read	发卡器读卡、给发卡器设备发送读卡指令,通过发卡器对指定卡片下发读卡指令, 从而获得卡片信息(卡片信息由Pulsar推送, 需要提前开启消息订阅)
GET	/v1.0/osaas/projects/{project_id}/card-issue-devices	获取项目下的锁&发卡器设备分页列表(通过项目唯一标识获取该项目下锁和发卡器等特定设备类型的设备信息)
GET	/v1.0/osaas/rooms/{room_id}/card-issue-devices	获取房屋下的锁&发卡器设备分页列表(通过房屋唯一标识获取锁和发卡器等特定设备类型的设备列表)
POST	/v1.0/osaas/projects/{project_id}/card-issue-devices/lock-devices/{device_id}/cards	门锁卡片信息操作：下发卡片(使用发卡器制卡生成的卡片唯一标识，对门锁进行门卡通行方式指令下发操作，从而达到使用指定门卡通行门锁的操作。)
DELETE	/v1.0/osaas/projects/{project_id}/card-issue-devices/lock-devices/{device_id}/cards/{lock_card_id}	门锁卡片信息操作：删除卡片(使用门锁卡片唯一标识对锁下发删除卡片指令，使该该门卡对门锁通行方式失效)
PUT	/v1.0/osaas/projects/{project_id}/card-issue-devices/lock-devices/{device_id}/cards/{lock_card_id}/freeze-status	门锁卡片信息操作：卡片状态修改(使用门锁卡片唯一标识对指定门锁对应卡片状态进行修改，支持冻结和解冻两种操作。)
PUT	/v1.0/osaas/projects/{project_id}/card-issue-devices/lock-devices/{device_id}/cards/{lock_card_id}	门锁卡片信息操作：卡片修改(通过生效时间和失效时间对指定门锁下发通行卡片的授权时间修改指令，在无需使用发卡器重新制卡的情况下，对门卡通行时间修改。)

错误码

错误码	错误Code	错误描述
10701409	DEVICE_UNSUPPORTED	设备不支持该操作
10701410	CARD_NOT_FOUND	卡片不存在
10701411	LOCK_CARD_DEVICE_TYPE_UNSUPPORTED	设备类型不支持
10701412	DEVICE_OPERATING_NOT_RETRY	设备操作中、无需重试

Pulsar事件通知

相关操作使用消息通知、详情查看消息通知章节

协议号	bizCode&说明
10001	(“cardIssueCommandExecuteReport”,“发卡器写卡上报”),
10001	(“fkqCardReadCommandReport”,“发卡器读卡上报”)
10001	(“lockCreateCardCommandReport”,“门锁写卡上报”)
10001	(“lockDelCardCommandReport”,“门锁删卡上报”)
10001	(“lockModifyCardCommandReport”,“门锁改卡上报”)
10001	(“lockFreezeCardCommandReport”,“门锁冻结卡上报”)
10001	(“lockUnFreezeCardCommandReport”,“门锁解冻卡上报”)

1、网络发卡-发卡器写卡上报

BizCode：cardIssueCommandExecuteReport

描述：发卡器写卡事件结果上报

字段	类型	含义
operateId	String	操作唯一标识(通OpenAPI调用返回值)
operateResult	Integer	操作结果
deviceId	String	设备标识
cardId	String	卡片唯一标识

操作结果明细

字段	含义
0	超时
1	成功
2	超时
3	未检测到卡
4	非法卡

2、网络发卡-发卡器读卡上报

BizCode：fkqCardReadCommandReport

描述：发卡器读卡事件结果上报

字段	类型	含义
operateId	String	操作唯一标识(通OpenAPI调用返回值)
operateResult	Integer	操作结果
deviceId	String	设备标识
cardInfo	JsonString	卡片内容

字段	类型	含义
cardId	String	卡片唯一标识
cardUid	String	卡片硬件标识
effectiveTime	Long	生效时间
invalidTime	Long	失效时间

操作结果明细

字段	含义
0	超时
1	成功
2	超时
3	未检测到卡
4	非法卡

3、卡密锁执行结果事件上报-门锁写卡上报

BizCode：lockCreateCardCommandReport

描述：门锁写卡上报

字段	类型	含义
operateId	String	操作唯一标识(通OpenAPI调用返回值)
operateResult	Integer	操作结果
lockCardId	String	锁内卡片唯一标识
deviceId	String	设备标识

操作结果明细

字段	含义
-1	回复超时
1	失败
2	成功
3	解锁方式重复
4	解锁方式已满
5	解锁方式不存在

4、卡密锁执行结果事件上报-门锁删卡上报

BizCode：lockDelCardCommandReport

描述：门锁删卡上报

字段	类型	含义
operateId	String	操作唯一标识(通OpenAPI调用返回值)
operateResult	Integer	操作结果
lockCardId	String	锁内卡片唯一标识
deviceId	String	设备标识

5、卡密锁执行结果事件上报-门锁改卡上报

BizCode：lockModifyCardCommandReport

描述：门锁改卡上报

字段	类型	含义
operateId	String	操作唯一标识(通OpenAPI调用返回值)
operateResult	Integer	操作结果
lockCardId	String	锁内卡片唯一标识
deviceId	String	设备标识

6、卡密锁执行结果事件上报-门锁冻结卡上报

BizCode：lockFreezeCardCommandReport

描述：门锁冻结卡上报

字段	类型	含义
operateId	String	操作唯一标识(通OpenAPI调用返回值)
operateResult	Integer	操作结果
lockCardId	String	锁内卡片唯一标识
deviceId	String	设备标识

7、卡密锁执行结果事件上报-门锁解冻卡上报

BizCode：lockUnFreezeCardCommandReport

描述：门锁解冻卡上报

字段	类型	含义
operateId	String	操作唯一标识(通OpenAPI调用返回值)
operateResult	Integer	操作结果
lockCardId	String	锁内卡片唯一标识
deviceId	String	设备标识