Livion Key

Livion Key är ett system för nyckelhantering. Systemet kan skicka händelser om nyckelskåp och nycklar till externa system. Orbiq har ett API som tar emot dessa händelser via Webhooks och omvandlar de händelser som stöds till larm.

Orbiq hanterar två typer av händelser från Livion Key:

• device-alarm för larm från ett nyckelskåp.
• key-status för en nyckel som inte har återlämnats eller som har återlämnats.

Följande larmtyper stöds för device-alarm:

Prioriteterna ovan är Orbiqs standardinställning. Systemadministratören kan ändra vilka larmtyper som får prioritet A samt vilken standardprioritet som ska användas för övriga larm.

Fältet acknowledged kan förekomma i ett device-alarm. Värdet tas med i larmtexten och metadata, men det skapar inte en händelse med statusen Kvitterat i Orbiq.

Orbiq grupperar händelser under en teknisk beteckning för larmpunkten. För enhetslarm används:

livion-key:{deviceId}:{alarmType}

Exempel:

livion-key:LK-1:DEVICE_ERROR

För en nyckel som inte har återlämnats används:

livion-key:{deviceId}:KEY_NOT_RETURNED:{nyckelidentifierare}

Exempel:

livion-key:LK-1:KEY_NOT_RETURNED:KEY-7

keyId används i första hand som nyckelidentifierare. Om det saknas används lockerIndex eller contractId.

Larmpunktens beskrivning och larmhändelsens text skapas på engelska utifrån händelsens innehåll. Exempel på beskrivningar är:

Device error activated for device LK-1
Key not returned for device LK-1
Key returned for device LK-1

Larmhändelsens text innehåller även eventtyp, deviceId, status, tidsuppgifter och andra relevanta fält som finns i händelsen. Relevanta payloadfält lagras också som metadata och kan hämtas via Orbiqs API. Metadata visas normalt inte i Orbiqs användargränssnitt.

Ett aktiverat enhetslarm kan se ut så här:

{
  "type": "device-alarm",
  "deviceId": "LK-1",
  "alarmType": "DEVICE_ERROR",
  "state": "activated",
  "start": "2026-01-02T03:04:05.000Z",
  "end": null,
  "acknowledged": false
}

En händelse för en nyckel som inte har återlämnats kan se ut så här:

{
  "type": "key-status",
  "deviceId": "LK-1",
  "lockerIndex": 12,
  "state": "key-not-returned",
  "time": "2026-01-02T05:06:07.000Z",
  "keyId": "KEY-7"
}

Orbiq-administratören lägger upp den API-nyckel som ska användas av Livion Key-integrationen. API-nyckeln ska därefter skickas med varje anrop i HTTP-headern x-api-key.

I Livion Key registreras Orbiqs endpoint för mottagning av händelser enligt formatet nedan. Platshållaren {orbiq_url} ska bytas ut mot den faktiska adressen till Orbiq-installationen.

https://{orbiq_url}/api/iqalarm/alarmEvent/livion-key

Livion Key ska skicka en HTTP POST med JSON-data till adressen. Följande headers ska anges:

Content-Type: application/json
x-api-key: {api_key}

I Orbiq registreras en separat larmkälla för varje Livion Key-enhet:

1. Aktivera Larmhantering på resursen.
2. Ange Livion-enhetens exakta deviceId i fältet Adress för identifiering av larmkällan.
3. Välj livion-key som larmformat.
4. Markera larmkällan som Publicerad.

Händelserna key-fetched, contract-update och code-entered stöds inte av integrationen. De ignoreras utan att skapa larm.