Wir arbeiten fleißig an neuen Features. Heute können wir Ihnen erneut eine weitere Prüfungsart vorstellen: REST API Check. Mit diesem Checktyp haben Sie die Möglichkeit ein Rest-Interface anzusprechen und dessen Ergebnis auszuwerten. Dazu geben Sie die Url, die HTTP-Methode sowie weitere Parameter an, die für die Prüfung verwendet werden sollen. Sie haben auch die Möglichkeit die Rückgabewerte (sofern es sich um eine JSON Rest API handelt) auszuwerten und anhand der zurückgegebenen Werte den Zustand der Prüfung zu definieren.
Wenn eine Schnittstelle also z.B. folgendes zurückgibt:
{ "value" : 4 }
haben Sie die Möglichkeit diesen Wert zu prüfen indem Sie bei der "Erfolgsbedingung" folgendes eingeben:
value <= 4
Dies sorgt dafür, dass der Wert von "value" klein oder gleich 4 sein muss, damit die Prüfung nicht fehlschlägt.
Wir werden in Kürze eine detaillierte Beschreibung dieser und der anderen Schnittstellen zur Verfügung stellen.
Hier beantworten wir Fragen zur Serverüberwachung von Livewatch. Wenn Sie eine Frage haben, die wir hier noch nicht beantwortet haben, kontaktieren Sie uns bitte.
Ein API-Token (Application Programming Interface-Token) ist ein Sicherheitsmechanismus, der dazu dient, den Zugriff auf eine API (Application Programming Interface) zu kontrollieren und zu authentifizieren. APIs ermöglichen es Softwareanwendungen, miteinander zu kommunizieren und Daten auszutauschen. API-Token dienen als Form der Identifikation und Autorisierung, um sicherzustellen, dass nur autorisierte Anwendungen oder Benutzer auf eine bestimmte API zugreifen können.
Im Allgemeinen funktioniert ein API-Token, indem es einen eindeutigen Schlüssel bereitstellt, der bei jeder API-Anfrage mitgesendet wird. Dieser Schlüssel dient dazu, die Identität des Aufrufenden zu überprüfen und sicherzustellen, dass sie die erforderlichen Berechtigungen für den Zugriff auf die gewünschten Ressourcen haben.
Es gibt verschiedene Arten von API-Token, darunter:
API-Key: Ein einfacher Schlüssel, der oft als Parameter in der Anfrage oder im Header mitgesendet wird.
OAuth-Token: Verwendet das OAuth-Protokoll zur Authentifizierung und Autorisierung. Es ermöglicht eine feinere Steuerung der Berechtigungen und wird häufig für den Zugriff auf geschützte Ressourcen verwendet.
JWT (JSON Web Token): Ein kompaktes, selbstbeschreibendes Token-Format, das in der Regel zur Übertragung von Ansprüchen zwischen Parteien verwendet wird. Es kann auch als API-Token verwendet werden.
Die Verwendung von API-Token hilft, die Sicherheit zu erhöhen, indem sie sicherstellen, dass nur autorisierte Parteien auf die API zugreifen können, und ermöglicht gleichzeitig eine effiziente und flexible Integration von Anwendungen.
Ein "REST API Check" bezieht sich auf die Überprüfung einer RESTful API (Representational State Transfer Application Programming Interface) auf ihre Verfügbarkeit, Funktionalität und Konformität mit den definierten Standards. REST ist ein Architekturstil für die Entwicklung von Webdiensten, bei dem Ressourcen über standardisierte HTTP-Methoden (wie GET, POST, PUT und DELETE) manipuliert werden.
Ein REST API Check kann verschiedene Aspekte umfassen:
Endpunkte und Ressourcen: Überprüfung der verfügbaren API-Endpunkte und der Ressourcen, die durch diese Endpunkte bereitgestellt werden. Dies umfasst die Überprüfung von GET-Anfragen, um sicherzustellen, dass die erwarteten Daten zurückgegeben werden.
HTTP-Methoden: Überprüfung der Unterstützung und korrekten Verwendung verschiedener HTTP-Methoden wie GET, POST, PUT und DELETE gemäß den API-Spezifikationen.
Parametervalidierung: Überprüfung, ob die API-Endpunkte korrekt auf Anfragen mit den erforderlichen Parametern reagieren und in der Lage sind, ungültige oder fehlende Parameter ordnungsgemäß zu behandeln.
Authentifizierung und Autorisierung: Überprüfung der Authentifizierung und Autorisierung, um sicherzustellen, dass nur autorisierte Benutzer oder Anwendungen auf geschützte Ressourcen zugreifen können.
Statuscodes: Überprüfung der zurückgegebenen HTTP-Statuscodes, um sicherzustellen, dass sie den API-Spezifikationen entsprechen. Erfolgreiche Anfragen sollten beispielsweise den Statuscode 200 (OK) zurückgeben.
Format der Antwortdaten: Überprüfung des Formats der zurückgegebenen Daten, wie JSON oder XML, um sicherzustellen, dass sie den Erwartungen entsprechen.
Fehlerbehandlung: Überprüfung der Fehlerbehandlung, um sicherzustellen, dass die API angemessene Fehlermeldungen zurückgibt, wenn unerwartete Situationen auftreten.
REST API Checks werden oft als Teil des API-Monitorings eingesetzt, um sicherzustellen, dass eine API ordnungsgemäß funktioniert und die erwarteten Ergebnisse liefert. Dies ist besonders wichtig in verteilten Anwendungslandschaften, in denen verschiedene Dienste miteinander kommunizieren.
Es gibt verschiedene Tools und Dienste, die speziell für das Testen von REST APIs entwickelt wurden und automatisierte Überprüfungen durchführen können. Diese Checks können auch in Continuous Integration (CI)- und Continuous Deployment (CD)-Prozesse integriert werden, um sicherzustellen, dass Änderungen an einer API keine negativen Auswirkungen auf deren Funktionalität haben.