Create a third party OSDP Reader component
curl --request POST \
--url https://api2.rhombussystems.com/api/component/createOsdpDoorReader \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"allowUnencrypted": true,
"disableCardReader": true,
"disableKeypad": true,
"name": "<string>",
"otherReaderUnlockAudioFeedbackEnabled": true,
"ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"port": {
"boardNum": 123,
"portNum": 123,
"portType": "RS485"
},
"remoteUnlockAudioFeedbackEnabled": true
}
'import requests
url = "https://api2.rhombussystems.com/api/component/createOsdpDoorReader"
payload = {
"allowUnencrypted": True,
"disableCardReader": True,
"disableKeypad": True,
"name": "<string>",
"otherReaderUnlockAudioFeedbackEnabled": True,
"ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"port": {
"boardNum": 123,
"portNum": 123,
"portType": "RS485"
},
"remoteUnlockAudioFeedbackEnabled": True
}
headers = {
"x-auth-scheme": "<x-auth-scheme>",
"x-auth-apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-auth-scheme': '<x-auth-scheme>',
'x-auth-apikey': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
allowUnencrypted: true,
disableCardReader: true,
disableKeypad: true,
name: '<string>',
otherReaderUnlockAudioFeedbackEnabled: true,
ownerDeviceUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
port: {boardNum: 123, portNum: 123, portType: 'RS485'},
remoteUnlockAudioFeedbackEnabled: true
})
};
fetch('https://api2.rhombussystems.com/api/component/createOsdpDoorReader', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/component/createOsdpDoorReader")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"allowUnencrypted\": true,\n \"disableCardReader\": true,\n \"disableKeypad\": true,\n \"name\": \"<string>\",\n \"otherReaderUnlockAudioFeedbackEnabled\": true,\n \"ownerDeviceUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"port\": {\n \"boardNum\": 123,\n \"portNum\": 123,\n \"portType\": \"RS485\"\n },\n \"remoteUnlockAudioFeedbackEnabled\": true\n}")
.asString();{
"component": {
"allowUnencrypted": true,
"baseType": "reader",
"createdAtMillis": 123,
"disableCardReader": true,
"disableKeypad": true,
"disableWaveToUnlock": true,
"disposition": "INGRESS",
"name": "<string>",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"osdpAddress": 123,
"otherReaderUnlockAudioFeedbackEnabled": true,
"ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"ownerHardwareType": "RASPBERRY_PI_3",
"port": {
"boardNum": 123,
"portNum": 123,
"portType": "RS485"
},
"portImmutable": true,
"readerType": "wiegand",
"remoteUnlockAudioFeedbackEnabled": true,
"type": "RhombusOsdpDoorReader",
"updatedAtMillis": 123,
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
}Component Webservice
Create a third party OSDP Reader component
Create a third party OSDP Reader component
POST
/
api
/
component
/
createOsdpDoorReader
Create a third party OSDP Reader component
curl --request POST \
--url https://api2.rhombussystems.com/api/component/createOsdpDoorReader \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"allowUnencrypted": true,
"disableCardReader": true,
"disableKeypad": true,
"name": "<string>",
"otherReaderUnlockAudioFeedbackEnabled": true,
"ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"port": {
"boardNum": 123,
"portNum": 123,
"portType": "RS485"
},
"remoteUnlockAudioFeedbackEnabled": true
}
'import requests
url = "https://api2.rhombussystems.com/api/component/createOsdpDoorReader"
payload = {
"allowUnencrypted": True,
"disableCardReader": True,
"disableKeypad": True,
"name": "<string>",
"otherReaderUnlockAudioFeedbackEnabled": True,
"ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"port": {
"boardNum": 123,
"portNum": 123,
"portType": "RS485"
},
"remoteUnlockAudioFeedbackEnabled": True
}
headers = {
"x-auth-scheme": "<x-auth-scheme>",
"x-auth-apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-auth-scheme': '<x-auth-scheme>',
'x-auth-apikey': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
allowUnencrypted: true,
disableCardReader: true,
disableKeypad: true,
name: '<string>',
otherReaderUnlockAudioFeedbackEnabled: true,
ownerDeviceUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
port: {boardNum: 123, portNum: 123, portType: 'RS485'},
remoteUnlockAudioFeedbackEnabled: true
})
};
fetch('https://api2.rhombussystems.com/api/component/createOsdpDoorReader', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/component/createOsdpDoorReader")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"allowUnencrypted\": true,\n \"disableCardReader\": true,\n \"disableKeypad\": true,\n \"name\": \"<string>\",\n \"otherReaderUnlockAudioFeedbackEnabled\": true,\n \"ownerDeviceUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"port\": {\n \"boardNum\": 123,\n \"portNum\": 123,\n \"portType\": \"RS485\"\n },\n \"remoteUnlockAudioFeedbackEnabled\": true\n}")
.asString();{
"component": {
"allowUnencrypted": true,
"baseType": "reader",
"createdAtMillis": 123,
"disableCardReader": true,
"disableKeypad": true,
"disableWaveToUnlock": true,
"disposition": "INGRESS",
"name": "<string>",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"osdpAddress": 123,
"otherReaderUnlockAudioFeedbackEnabled": true,
"ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"ownerHardwareType": "RASPBERRY_PI_3",
"port": {
"boardNum": 123,
"portNum": 123,
"portType": "RS485"
},
"portImmutable": true,
"readerType": "wiegand",
"remoteUnlockAudioFeedbackEnabled": true,
"type": "RhombusOsdpDoorReader",
"updatedAtMillis": 123,
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
}Authorizations
Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).
Headers
Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.
Available options:
api-token, api, partner-api-token, partner-api Body
application/json
base 64 (url-safe) uuid string
Example:
"AAAAAAAAAAAAAAAAAAAAAA"
Show child attributes
Show child attributes
Response
200 - application/json
OK
Show child attributes
Show child attributes
Last modified on September 21, 2026