Card Issuer Management

This article introduces the card issuer related API.

API List

Request method	API	Description
POST	/v1.0/osaas/projects/{project_id}/card-issue-devices/card-issuer/{device_id}/card-info-write	Card issuer card writing: send card writing command to the card issuer device (according to the effective time and expiration time, send the card writing command to the card issuer to generate card information)
POST	/v1.0/osaas/projects/{project_id}/card-issue-devices/card-issuer/{device_id}/card-info-read	Card issuer card reading: send card reading command to the card issuer device, and issue card reading command to the specified card through the card issuer to obtain card information (card information is pushed by Pulsar, and message subscription needs to be enabled in advance)
GET	/v1.0/cloud/osaas/projects/{project_id}/card-issue-devices/card-issuer/card-info/{card_id}	Query the card information issued by the card issuer

Card Issuer Card Writing

This article introduces the API for writing cards.

API Description

According to the effective time and expiration time, send the card writing command to the card issuer to generate card information.

API Address

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

Request Parameters

Parameter	Type	Position	Mandatory	Description
project_id	String	uri	true	Unique ID of the project
device_id	String	uri	true	Unique ID of the device
request	IssuingWriteCardRequest		false	Card issuer write card request body

request description

Parameter	Type	Position	Mandatory	Description
begin_time	Long		false	Card effective time, 13-digit timestamp
end_time	Long		false	Card expiration time, 13-digit timestamp

Response Parameters

Parameter	Type	Description
result	IssuingWriteCardResponse	Response of card issuer writes the card

result description

Parameter	Type	Description
operate_id	String	Operation unique id
operate_result	Boolean	Operation result
card_id	String	Card unique identification

Request Example

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

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

Response Example

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

Card Issuer Card Reading

This article introduces the API for reading cards.

API Description

Send card reading command to the specified card through the card issuer to obtain card information. Card information is pushed by Pulsar, and message subscription needs to be enabled in advance.

API Address

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

Request Parameters

Parameter	Type	Position	Mandatory	Description
project_id	String	uri	true	Unique ID of the project
device_id	String	uri	true	Unique ID of the device
request	IssuingReadCardRequest		false	Card Issuer read card request

request description

Parameter	Type	Position	Mandatory	Description
operate_type	String		false	Operation type

Response Parameters

Parameter	Type	Description
result	IssuingReadCardResponse	Response of card issuer reads the card

result description

Parameter	Type	Description
operate_id	String	Operation unique id
operate_result	Boolean	Operation result

Request Example

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

Response Example

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

Card Issuer Card Querying

This article introduces the API for querying card information.

API Description

Query card information based on card id.

API Address

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

Request Parameters

Parameter	Type	Position	Mandatory	Description
project_id	String	uri	true	Unique ID of the project
card_id	String	uri	true	Unique ID of the card

Response Parameters

Parameter	Type	Description
result	IssuingCardInfoResponse	Card information return result

result description

Parameter	Type	Description
card_id	String	Unique id of the card
card_uuid	String	Card hardware id
begin_time	Long	Card effective time, 13-digit timestamp
end_time	Long	Card expiration time, 13-digit timestamp
card_status	String	Card issuance status: ISSUING, ISSUE_SUCCESS, ISSUE_FAILED

Request Example

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

Response Example

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