发卡器管理

本文介绍发卡器相关能力API

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/cloud/osaas/projects/{project_id}/card-issue-devices/card-issuer/card-info/{card_id}	查询发卡器下发的卡片信息

发卡器制卡,给发卡器设备发送制卡指令

本文介绍发卡器制卡的 API。

接口描述

根据生效时间与失效时间，对发卡器下发制卡指令，生成卡片信息。

接口地址

POST: /v1.0/osaas/projects/{project_id}/card-issue-devices/card-issuer/{device_id}/card-info-write

请求参数

参数名	类型	参数位置	是否必填	说明
project_id	String	uri	true	项目唯一标识
device_id	String	uri	true	设备唯一标识
request	IssuingWriteCardRequest		false	发卡器制卡请求体

request 说明

参数名	类型	参数位置	是否必填	说明
begin_time	Long		false	卡片生效时间
end_time	Long		false	卡片失效时间

返回参数

参数名	类型	说明
result	IssuingWriteCardResponse	发卡器制卡返回结果

result 说明

参数名	类型	说明
operate_id	String	操作唯一标识
operate_result	Boolean	操作结果
card_id	String	卡片唯一标识

请求示例

POST: /v1.0/osaas/projects/150188910571223***/card-issue-devices/card-issuer/6c470253258246b99****/card-info-write

{
  "beginTime": 1658303985000,
  "endTime": 1666252785000
}

返回示例

{
    "tid": "aae3ead40e3a11ed818882d0e***",
    "result": {
        "operate_id": "1552534592777359***",
        "operate_result": true,
        "card_id": "15525345928151***"
    },
    "t": 1658988066464,
    "success": true
}

发卡器读卡、给发卡器设备发送读卡指令

本文介绍发卡器读卡的 API。

接口描述

发卡器对指定卡片下发读卡指令, 从而获得卡片信息。卡片信息由 Pulsar 推送, 需要提前开启消息订阅服务。

接口地址

POST: /v1.0/osaas/projects/{project_id}/card-issue-devices/card-issuer/{device_id}/card-info-read

请求参数

参数名	类型	参数位置	是否必填	说明
project_id	String	uri	true	项目唯一标识
device_id	String	uri	true	设备唯一标识
request	IssuingReadCardRequest		false	发卡器读卡请求

request 说明

参数名	类型	参数位置	是否必填	说明
operate_type	String		false	操作类型

返回参数

参数名	类型	说明
result	IssuingReadCardResponse	发卡器读卡返回结果

result 说明

参数名	类型	说明
operate_id	String	操作唯一标识
operate_result	Boolean	操作结果

请求示例

POST: /v1.0/osaas/projects/150188910571223***/card-issue-devices/card-issuer/6c470253258246b99*****/card-info-read

返回示例

{
    "tid": "3be4aa970e3d11ed8a61ba62b92******",
    "result": {
        "operate_id": "1552539216750055***",
        "operate_result": true
    },
    "t": 1658989168814,
    "success": true
}

查询发卡器下发的卡片信息

本文介绍查询卡片信息的 API。

接口描述

根据卡片id查询卡片信息。

接口地址

GET:/v1.0/cloud/osaas/projects/{project_id}/card-issue-devices/card-issuer/card-info/{card_id}

请求参数

参数名	类型	参数位置	是否必填	说明
project_id	String	uri	true	项目唯一标识
card_id	String	uri	true	卡片唯一标识

返回参数

参数名	类型	说明
result	IssuingCardInfoResponse	卡片信息返回结果

result 说明

参数名	类型	说明
card_id	String	卡片唯一标识
card_uuid	String	卡片硬件id
begin_time	Long	卡片生效时间
end_time	Long	卡片失效时间
card_status	String	卡片下发状态：ISSUING-下发中，ISSUE_SUCCESS-下发成功，ISSUE_FAILED-下发失败

请求示例

GET:/v1.0/cloud/osaas/projects/150188910571223***/card-issue-devices/card-issuer/card-info/15525345928151***

返回示例

{
    "tid": "3be4aa970e3d11ed8a61ba62b92******",
    "result": {
        "card_id": "15525345928151***",
        "card_uuid": "Xp9w***",
        "begin_time": 1750215196649,
        "end_time": 1750225196649,
        "card_status": "ISSUE_SUCCESS"
    },
    "t": 1658989168814,
    "success": true
}