Wie ihr Rest API’s für das Management von SIGNL4 Kategorien nutzt

Sep 20, 2023 | Integration

SIGNL4 Kategorien

Die Kategorien in SIGNL4 sind ein mächtiges Werkzeug, um Nutzern auf den ersten Blick deutlich zu machen, worum es bei einem bestimmten Alarm geht. Zum Beispiel können hier Farben, Icons, Location und vordefinierte Texte konfiguriert werden.

Kategorien können manuell angelegt und editiert werden.

Kategorien automatisiert verwalten

In bestimmten Umständen kann es sinnvoll sein, Kategorien automatisiert anzulegen oder zu löschen. Das kann zum Beispiel der Fall sein, wenn du mehrere Teams hast und diese nur bestimmte Kategorien nutzen möchten, oder auch, wenn du einen SIGNL4 Account mit deinen Kategorien ausstatten möchtest, bevor du ihn zum Beispiel an einen deiner Kunden übergibst. Das kann den Onboarding-Prozess für SIGNL4 Teams erheblich vereinfachen.

Kategorien per REST API managen

Das SIGNL4 REST API bietet Funktionen, um Kategorien hinzufügen, zu löschen und zu managen. Um das API zu nutzen, benötigst du einen SIGNL4 API Key. Den bekommst du im SIGNL4-Web-Portal unter Integrationen -> API Keys.

Für das Managen der Kategorien sind insbesondere folgende Funktionen hilfreich.


# Get Teams
# As a result you get the team id(s) that you need in the next steps
GET https://connect.signl4.com/api/teams
X-S4-Api-Key: your-api-key

# Get Categories
# Get all categories for the given team
GET https://connect.signl4.com/api/categories/your-team-id
X-S4-Api-Key: your-api-key

# Add Category
POST https://connect.signl4.com/api/categories/your-team-id
X-S4-Api-Key: your-api-key
Content-Type: application/json
Accept: application/json

{
"augmentations": [
{
"enabled": false,
"name": "",
"type": "Subject",
"value": ""
},
{
"enabled": false,
"name": "",
"type": "Location",
"value": ""
},
{
"enabled": false,
"name": "",
"type": "Text",
"value": ""
}
],
"color": "#30AFE5",
"imageName": "bug.svg",
"keywordMatching": "Any",
"keywords": [
"keyword1",
"keyword2"
],
"name": "My New Category"
}

# Delete Category (team id / category id)
DELETE https://connect.signl4.com/api/categories/your-team-id/your-category-id
X-S4-Api-Key: your-api-key

Die obigen Codes sind übrigens aus Visual Studio Code. Mit der REST Client Extension kannst du die Requests auch direkt von dort aus aufrufen und testen. Das ist recht bequem und vielleicht auch schon eine Variante, um die Kategorie-Erzeugung zu vereinfachen.

Mehr Informationen zu kategorienbasierter Alarmierunng in SIGNL4 erhälst du hier.

Automatisierung mit Node-RED

Um das Erstellen oder Löschen von Kategorien zu automatisieren, kannst du zum Beispiel No-Code-Plattformen, wie Make.com, n8n oder Node-RED verwenden. Wir haben beispielhaft einen Node-RED Flow bereitgestellt, der eine Kategorie erstellt. Dort müssen die Funktionen mit den Parametern (API Key und Team ID) jeweils noch angepasst werden.