Skip to main content

Einführung

Erklärung REST API: Die ProgrammierschnittstelleKeyHelp-API-Schnittstelle REST-APIerlaubt nutztes HTTP-Anfragen,anderer umSoftware permit PUT,KeyHelp GET,zu POSTinteragieren und DELETEso bestimmte Aktionen auszulösen. Diese Funktion ist dann hilfreich, wenn diverse IT-Prozesse automatisiert werden sollen.

Die im KeyHelp implementierte API arbeitet nach dem REST Prinzip. Das bedeutet, es werden HTTP Anfragen für den Zugriff auf Informationendie zuzugreifen.Daten verwendet werden. Über die verschiedenen HTTP-Methoden werden entsprechende Aktionen abgebildet.

  • GET - Abfrage von Daten
  • PUT - Aktualisierung von Daten
  • POST - Erstellen von Daten
  • DELETE - Löschen von Daten

Entsprechend antwortet die API je nach Aktion mit den bekannten HTTP-Status-Codes:

  • 200 - OK
  • 201 - CREATED
  • 400 - BAD REQUEST
  • 404 - NOT FOUND
  • usw.

Um die Gültigkeit einer API-Anfrage zu verifizieren, muss bei jeder Anfrage ein API-Schlüssel erstellen

als

Teil dieser gesendet werden werden. Dieser API-Schlüssel kann direkt über das KeyHelp-Benutzerinterface erstellt werden. Zusätzlich muss die API zunächst aktiviert werden. Alle relevanten Optionen finden Sie im KeyHelp-Administrationsbereich unter Konfiguration -> an sicherem ort speichern, nachgräglich keine wiederherstellung möglich

- X-API-KEY in header

 API.

Interaktive Dokumentation

Eine Vollständige API-Dokumentation finden Sie unter folgender URL: https://api.keyhelp.de
Dort erhalten Sie eine detaillierte Beschreibung aller API-Endpunkte und erfahren wie API-Anfragen aufgebaut und API-Antworten strukturiert sein können. Darüber hinaus können Sie sämtliche Endpunkte interaktiv, direkt über Ihren Browser testen.

Um die interaktive Test-Umgebung zu verwenden, betätigen Sie den Button Try it out, den Sie unter der Erklärung eines jeden Endpunktes finden. Klicken Sie anschließend den Button Execute um eine Anfrage abzuschicken. Um Anfragen direkt zu einem Server Ihrer Wahl zu schicken. Füllen Sie im oberen Bereich der API-Dokumentation zunächst die Eingabefelder host sowie die nach einem Klick auf dem Button Authorize erscheinenden Eingabefelder aus.

- json / jaml

 

Sicherheit

-Die empfiehtlSicherheit der API-Schnittstelle wird durch verschiedenste Mechanismen sichergestellt, so dass es Angreifern fast unmöglich ist, sich immerper IPBrute-Force beschränkungunberechtigt Zugriff zu setzen.
-verschaffen. fallsDie nichtSchnittstelle bietetsollte dennoch nur als sicher angesehen, wenn der schlüsselZugriff auf grundein seineroder längemehrere aberIP-Adressen auch/ ausrecihendIP-Bereiche sicherheit.beschränkt wird.
- Schlüssel ist nicht in KeyHelp datenbank gespeichert
- weiterhin werden wiederholte fehlgeschlagene auth versuche beiIn der APIKeyHelp-Oberfläche verlangsamtkönnen Sie über die Eigenschaften eines API-Schlüssels die gewünschten freigegebenen IPs hinterlegen.

 

Beispiel-Code

Um Ihnen den Einstieg zu erleichtern finden Sie unter Code-Beispiele kurze Anleitungen zur API. Beachten Sie, dass der dort gezeigte Code Ihnen lediglich den Umgang mit der API verdeutlichen soll, Fehlerbehandlungsroutinen und Ähnliches müssen entsprechend von Ihnen programmiert werden.

Im Beispielcode finden Sie Platzhalter insnach mitdem Schema <NAME>, gekennzeichnet.die Sie ersetzen müssen.
Ersetzen Sie <HOSTNAME> mit dem Hostnamen oder IP Ihres KeyHelp Servers. 
Ersetzen Sie <API-KEY> mit Ihrem APIAPI-Schlüssel Key.Ihres Servers.

Hier finden Sie Code-Beispiele *LINK*. Beachten Sie, der hier gezeigte Code enthält das absolute minimum an Code, für Fehler-abfang routinen sind sie selbst verantwortlich.

 

Back to top