API-Schlüssel und Endpunkte verwalten

Inhaltsverzeichnis

  1. Was ist eine API
  2. Was sind API-Schlüssel
  3. Was sind Endpunkte
  4. API-Schlüssel in Cloudrexx verwalten
  5. Endpunkt in Cloudrexx bearbeiten
    1. Erlaubte Attribute
    2. Bedingungen
    3. Erlaubte Ausgabemodule
    4. Zugriffsberechtigungen


Was ist eine API

API ist die Abkürzung für "Application Programming Interface". Programmteile komplexerer Programme werden in sogenannte Komponenten abgekapselt und können über die API mit anderen Komponente kommunizieren.

Daher fungieren APIs vor allem als Datenübermittler. Durch die Abkapselung wird die einzelne Komponente lesbarer und Fehler können einfacher gefunden werden.


Was sind API-Schlüssel

Der Schlüssel für die Programmierschnittstelle (API) ist ein Code welcher verwendet wird, um das aufrufende Programm, seinen Entwickler oder seinen Benutzer zu identifizieren. Dadurch kann einem Missbrauch vorgebeugt werden. 


Was sind Endpunkte

Die Endpunkte verwalten den Zugriff auf die Daten. Der Zugriff wird von den Endpunkten vereinheitlicht, wodurch nicht zwischen verschiedenen Daten-Ressourcen (Daten aus einer Datenbank, Daten aus einem Verzeichnis) unterschieden werden muss.  


API-Schlüssel in Cloudrexx verwalten

In Cloudrexx können API-Schlüssel erstellt, bearbeitet und gelöscht werden. Die API-Schlüssel können unter dem Menüpunkt Administration -> API-Schlüssel verwaltet werden. 


Sie befinden sich nun auf der Übersicht der API-Schlüssel.

  1. Einen neuen API-Schlüssel hinzufügen
  2. Einen bestehenden API-Schlüssel bearbeiten
  3. Einen bestehenden API-Schlüssel löschen


Möchte man einen API-Schlüssel erstellen oder bearbeiten, sieht die Ansicht wie folgt aus: 

  1. Dabei handelt es sich um den Code, welcher bei der API beigelegt wird, um den Aufruf zu verifizieren. Der Knopf "Generiere API-Schlüssel" generiert eine sechs-stellige Zeichenkette. 
  2. Um festzulegen welche Endpunkte mit diesem API-Schlüssel verifiziert werden sollen, können hier ausgewählt werden.
  3. Soll auf die Endpunkte nur mit einer Leseberechtigung zugegriffen werden können, wählen Sie in diesem Menü die Endpunkte aus.