curl --request POST \
--url https://api2.rhombussystems.com/api/keypad/claimKeypadActivationToken \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"activationToken": "act_token_12345",
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"name": "Main Entrance Keypad",
"subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"
}
'import requests
url = "https://api2.rhombussystems.com/api/keypad/claimKeypadActivationToken"
payload = {
"activationToken": "act_token_12345",
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"name": "Main Entrance Keypad",
"subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"
}
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({
activationToken: 'act_token_12345',
locationUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
name: 'Main Entrance Keypad',
subLocationsHierarchyKey: 'AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA'
})
};
fetch('https://api2.rhombussystems.com/api/keypad/claimKeypadActivationToken', 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/keypad/claimKeypadActivationToken")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"activationToken\": \"act_token_12345\",\n \"locationUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"name\": \"Main Entrance Keypad\",\n \"subLocationsHierarchyKey\": \"AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA\"\n}")
.asString();{
"error": true,
"errorMsg": "<string>",
"warningMsg": "<string>"
}Claim keypad activation token
Connects a keypad to Rhombus services
curl --request POST \
--url https://api2.rhombussystems.com/api/keypad/claimKeypadActivationToken \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"activationToken": "act_token_12345",
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"name": "Main Entrance Keypad",
"subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"
}
'import requests
url = "https://api2.rhombussystems.com/api/keypad/claimKeypadActivationToken"
payload = {
"activationToken": "act_token_12345",
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"name": "Main Entrance Keypad",
"subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"
}
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({
activationToken: 'act_token_12345',
locationUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
name: 'Main Entrance Keypad',
subLocationsHierarchyKey: 'AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA'
})
};
fetch('https://api2.rhombussystems.com/api/keypad/claimKeypadActivationToken', 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/keypad/claimKeypadActivationToken")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"activationToken\": \"act_token_12345\",\n \"locationUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"name\": \"Main Entrance Keypad\",\n \"subLocationsHierarchyKey\": \"AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA\"\n}")
.asString();{
"error": true,
"errorMsg": "<string>",
"warningMsg": "<string>"
}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.
api-token, api, partner-api-token, partner-api Body
Request object for claiming a keypad activation token to connect a keypad to Rhombus services.
Activation token for claiming the keypad
"act_token_12345"
base 64 (url-safe) uuid string
"AAAAAAAAAAAAAAAAAAAAAA"
Name for the keypad
"Main Entrance Keypad"
A sequence of one or more base 64 (url-safe) uuid substrings. These substrings are separated by dots (.).
^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$"AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"