Pass Templates
Webhook Subscriptions
Webhooks
Create reader
curl --request POST \
--url https://api.passentry.com/api/v1/entities/{entity_id}/readers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"reader": {
"name": "South Entrance Reader 1",
"id": "south_entrance_01",
"type": "VtapReader",
"password": "<string>",
"scanEnabled": true,
"redeemEnabled": false,
"addPointsEnabled": false,
"mifareClassicNfcEnabled": false,
"qrEnabled": false
}
}
'{
"data": {
"id": "east-gate-1",
"type": "reader",
"attributes": {
"name": "East Gate Reader",
"readerType": "PassentryReader",
"loggedIn": false,
"qrEnabled": true,
"mifareClassicNfcEnabled": false,
"scanEnabled": true,
"redeemEnabled": false,
"addPointsEnabled": false,
"ndefTagScanningEnabled": false
}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
entity_id
Body
Show child attributes
Show child attributes
Friendly display name of the reader
"South Entrance Reader 1"
Identifier of the reader
"south_entrance_01"
Type of reader: VtapReader or PassentryReader
VtapReader, PassentryReader Reader password. Required for PassentryReader type
Whether the reader is enabled for scanning. Only present for PassentryReader type.
Whether the reader is enabled for redeeming. Only present for PassentryReader type.
Whether the reader is enabled for adding points. Only present for PassentryReader type.
Whether the reader is enabled for Mifare Classic NFC scanning. Only present for PassentryReader type.
Whether the reader is enabled for QR code scanning. Only present for PassentryReader type.
Response
Created
Identifier of the reader
"west_entrance_01"
"reader"
Show child attributes
Show child attributes
Friendly display name of the reader
Type of reader: VtapReader or PassentryReader
Timestamp of the last time the reader was seen. Only present for PassentryReader type
Whether the reader is currently logged in. Only present for PassentryReader type
Whether the reader is enabled for scanning. Only present for PassentryReader type
Whether the reader is enabled for redeeming. Only present for PassentryReader type
Whether the reader is enabled for adding points. Only present for PassentryReader type
Whether the reader is enabled for Mifare Classic NFC scanning. Only present for PassentryReader type
Whether the reader is enabled for QR code scanning. Only present for PassEntryReader type
Was this page helpful?
curl --request POST \
--url https://api.passentry.com/api/v1/entities/{entity_id}/readers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"reader": {
"name": "South Entrance Reader 1",
"id": "south_entrance_01",
"type": "VtapReader",
"password": "<string>",
"scanEnabled": true,
"redeemEnabled": false,
"addPointsEnabled": false,
"mifareClassicNfcEnabled": false,
"qrEnabled": false
}
}
'{
"data": {
"id": "east-gate-1",
"type": "reader",
"attributes": {
"name": "East Gate Reader",
"readerType": "PassentryReader",
"loggedIn": false,
"qrEnabled": true,
"mifareClassicNfcEnabled": false,
"scanEnabled": true,
"redeemEnabled": false,
"addPointsEnabled": false,
"ndefTagScanningEnabled": false
}
}
}