September 2020 Update: API Zugang mittels API-Keys und verbesserte Webhook-Verwaltung

Unser September-Update bringt API-Keys, die nun im SIGNL4 Web-Portal verwaltet werden können. Damit ist es endlich möglich direkt selbstständig unser API zu verwenden.
Zudem haben wir kleinere Verbesserungen bei der Webhook-Verwaltung vorgenommen. Alle Details gibt es in diesem Blog-Artikel.

API-Key Verwaltung

Ab sofort ist es möglich, API-Keys für das SIGNL4 API zu im Web Portal zu verwalten. Die dort ausgestellten Schlüssel können dann benutzt werden, um API-Funktionen aufzurufen. Somit kannst du fortan SIGNL4 für deine Use Cases erweitern oder es z.B. tiefergehend in deine Systemlandschaft integrieren. Nachfolgend findest du einige Infos zu den Schlüsseln und dem Umgang damit:

Unterstützt wird aus Sicherheitsgründen eine zeitlich begrenzte Gültigkeit der Schlüssel. Laufen sie ab, können sie nicht mehr genutzt werden
Es ist möglich, Schlüssel nur für den Lesezugriff auszustellen oder aber Vollzugriff zu erteilen, d.h. Lese- und Schreibrechte mit dem Schlüssel freizugeben
Bei der Erstellung kannst du den Schlüssel einmalig im Klartext sehen und musst ihn dann sicher abspeichern. In SIGNL4 selbst kannst du ihn nach Erstellung nicht mehr komplett sehen
Wenn ein Schlüssel z.B. kompromittiert wurde, kannst du ihn erneuern. Dadurch verliert der alte Schlüssel seine Gültigkeit und kann nicht mehr verwendet werden

Wie benutzt man einen API-Key mit dem API?

Das ist sehr einfach, der API Key muss in einem speziellen HTTP-Header mit dem Namen “X-S4-Api-Key” angegeben werden. Nachfolgend ist ein kleines Request/Response Beispiel gargestellt, in welchem alle Nutzer in einem SIGNL4-Team abgerufen werden:

REQUEST:

GET https://devapi.signl4.com/api/users HTTP/1.1
Host: devapi.signl4.com
Connection: keep-alive
X-S4-Api-Key: f1a8d5a514572fd4f2f7i1958141d7930d92738n97b4e5af7fab0d1e8468d803
Content-Type: application/json

RESPONSE:

HTTP/1.1 200 OK
Content-Length: 1159
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Date: Thu, 10 Sep 2020 07:44:24 GMT

[{"id":"f0bd5063-9588-41cf-b3d9-94e5647dedc5","subscriptionId":"0acf8014-22f2-4503-88d7-f7d05b46744f","name":"Rene 🇩🇪","mail":"rene@signl4.com","isDeactivated":false,"isInvite":false,"colorIndex":0,"dutyInfos":{"lastChange":"2020-09-04T14:00:13Z","onDuty":false,"onManagerDuty":false,"overdue":false}},{"id":"c0fa968a-7d3e-4fe6-90e6-09961af3f700","subscriptionId":"0acf8014-22f2-4503-88d7-f7d05b46744f","name":"Ron","mail":"ron@signl4.com","isDeactivated":false,"isInvite":false,"colorIndex":2,"dutyInfos":{"lastChange":"2020-07-06T22:00:04Z","onDuty":false,"onManagerDuty":false,"overdue":false}}]

Webhook-Verbesserungen

SIGNL4 kann Benachrichtigungen an externe Webhooks bei diesen Ereignissen versenden. Es ist nun möglich, den registrierten Webhooks einen Namen zu geben, so dass ersichtlich bleibt, welches System sich dahinter verbirgt.

Des Weiteren kannst du einen Webhook jetzt auch deaktivieren. Somit wird er z.B. zeitweise nicht mehr benachrichtigt, wenn Wartungsarbeiten oder ähnliches im externen System stattfinden und der Webhook nicht aufgerufen werden soll.