curl --request POST \
--url https://api2.rhombussystems.com/api/license/getPaneLicenseStatus \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"paneId": "<string>"
}
'import requests
url = "https://api2.rhombussystems.com/api/license/getPaneLicenseStatus"
payload = { "paneId": "<string>" }
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({paneId: '<string>'})
};
fetch('https://api2.rhombussystems.com/api/license/getPaneLicenseStatus', 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/license/getPaneLicenseStatus")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"paneId\": \"<string>\"\n}")
.asString();{
"error": true,
"errorMsg": "<string>",
"gracePeriodEndDate": "2023-11-07T05:31:56Z",
"licenseUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"licensed": true,
"reason": "LICENSED",
"warningMsg": "<string>"
}Get pane license status
Whether this organization is currently licensed to use a PANE app. Any member of the organization may ask; the PANE gateway asks on the visitor’s behalf before serving the pane.
curl --request POST \
--url https://api2.rhombussystems.com/api/license/getPaneLicenseStatus \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"paneId": "<string>"
}
'import requests
url = "https://api2.rhombussystems.com/api/license/getPaneLicenseStatus"
payload = { "paneId": "<string>" }
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({paneId: '<string>'})
};
fetch('https://api2.rhombussystems.com/api/license/getPaneLicenseStatus', 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/license/getPaneLicenseStatus")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"paneId\": \"<string>\"\n}")
.asString();{
"error": true,
"errorMsg": "<string>",
"gracePeriodEndDate": "2023-11-07T05:31:56Z",
"licenseUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"licensed": true,
"reason": "LICENSED",
"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 checking whether the organization is licensed to use a PANE app.
Id of the pane (the id in the pane's hostname, .pane.rhombus.com)
Response
OK
Whether the organization may use a PANE app right now, and why not if it may not.
When the current entitlement lapses; absent for a license granted without a term
base 64 (url-safe) uuid string
"AAAAAAAAAAAAAAAAAAAAAA"
True when an active pane license is assigned to the pane
LICENSED, or why the pane is not licensed: NO_LICENSE, EXPIRED, INVALID_STATE
LICENSED, NO_LICENSE, EXPIRED, INVALID_STATE