Zurück zum Hilfecenter

Schnittstelle (API)

API-Zugang erstellen

Schlüssel anlegen, Rechteumfang wählen und Verbindung testen.

Die Schnittstelle unter api.elyph.io/v1 gibt Ihnen programmatischen Zugriff auf Ihre eigenen Daten — für Auswertungen im BI-Werkzeug, Anbindung an Ticketsysteme oder eigene Anwendungen.

Für wen

IT und Integrationsverantwortliche.

Voraussetzungen

Rolle mit Administrationsrecht

Ein Zugang entsteht so

  • Bezeichnung — Sprechender Name für den Zweck, etwa „BI-Anbindung Controlling“.
  • Berechtigungen — Lesend oder schreibend je Ressource, nach dem Prinzip der geringsten Rechte.
  • Geltungsbereich — Optional auf Standorte oder Bereiche eingegrenzt.
  • Gültigkeit — Ablaufdatum setzen; unbefristete Schlüssel sind ein Sicherheitsrisiko.
  • Schlüssel — Wird genau einmal angezeigt. Danach ist er nicht mehr abrufbar.

Sicherer Betrieb

  • Schlüssel niemals in Quellcode, Tabellen oder E-Mails ablegen — nur in einem Secret-Speicher.
  • Je Anwendung ein eigener Schlüssel, damit sich einzelne Integrationen abschalten lassen.
  • Regelmäßig wechseln; ein Schlüsselwechsel ist ohne Ausfall möglich, weil zwei Schlüssel parallel gültig sein können.
  • Nutzung überwachen: Zeitpunkt der letzten Verwendung und Anfragezahlen stehen je Schlüssel bereit.
  • Bei Verdacht sofort widerrufen; der Widerruf wirkt unmittelbar.

Die Schnittstelle liefert ausschließlich Daten Ihres Mandanten. Ein Schlüssel kann nie mehr sehen als die ihm zugewiesenen Berechtigungen.

Schritt für Schritt

  1. 1

    Zugang anlegen

    Unter „Schnittstelle“ einen Zugang mit sprechendem Namen erstellen, etwa „Instandhaltungssystem“.

  2. 2

    Rechte wählen

    Lesen oder Schreiben je Ressource; vergeben Sie nur, was das Zielsystem wirklich braucht.

  3. 3

    Schlüssel sichern

    Der Schlüssel wird genau einmal angezeigt. Danach ist nur noch der Prüfwert gespeichert.

  4. 4

    Verbindung testen

    Der Testknopf sendet eine Beispielanfrage gegen api.elyph.io/v1 und zeigt die Antwort.

Ergebnis

Ein funktionierender Zugang mit passendem Rechteumfang und Protokollierung jeder Anfrage.

Häufige Stolpersteine

  • Schlüssel im Quellcode ablegen: Nutzen Sie den Geheimnisspeicher Ihres Zielsystems.

Häufige Fragen

Was tun, wenn der Schlüssel verloren ging?
Neuen Schlüssel erzeugen und den alten widerrufen. Ein Wiederherstellen ist bewusst nicht möglich.

Verwandte Artikel