# Zugangsdaten (/docs/de/integrations/api/credentials)



Diese Seite richtet sich an die **Administration** des Workspace, die die
Zugangsdaten ausstellt. Die Entwicklerseite ist
[Automation API](./overview) - nur auf Englisch.

Ein **verbundenes System** ist eine andere Software, die eigenständig mit Ihrem
Workspace arbeitet: ein ERP, ein Data Warehouse, ein nächtlicher Job. Es meldet
sich mit eigenen Zugangsdaten an statt mit dem Konto einer Person, schreibt
Daten in einen Datensatz, startet einen Lauf und holt sich die Ergebnisse nach
seinem eigenen Zeitplan.

## Was ein verbundenes System tun kann [#was-ein-verbundenes-system-tun-kann]

Was es darf, entscheidet allein der Zugriff, den Sie seinen Zugangsdaten geben:
**den Workspace lesen**, **Daten schreiben** in einen Datensatz einer
analytischen App, **eine Pipeline ausführen** und **Ergebnisse lesen** als
herunterladbaren Export.

Mehr gibt es nicht. Welchen Zugriff Sie auch erteilen: Ein verbundenes System
kann keine Apps anlegen oder löschen, keine Pipeline ändern, keine
Visualisierung bearbeiten, niemanden einladen und keine Workspace-Einstellungen
ändern.

## Zugangsdaten ausstellen [#zugangsdaten-ausstellen]

Öffnen Sie die Seite **Zugriff** und dort den Tab **API-Zugangsdaten** neben den
Mitgliedern. Der Tab ist **nur für Admins**: Einem
Mitglied wird er gar nicht angeboten, und jede Anfrage dahinter wird für alle
außer Admins abgelehnt. Zugangsdaten gehören dem **Workspace**, nicht einer
Person - sie funktionieren weiter, wenn die erstellende Person den Workspace
verlässt. Die Liste nennt weiterhin die Person, die sie ausgestellt hat, und
markiert die Zugangsdaten mit **Ehemaliges Mitglied**, sobald diese Person
nicht mehr da ist. So haben Sie einen Anlass zu prüfen, ob die Integration noch
gewollt ist.

**Neue Zugangsdaten** fragt nach einem Namen, einer optionalen Beschreibung,
der Laufzeit der Zugangsdaten (30, 90, 180 oder 365 Tage; 365, sofern Sie nichts
anderes wählen) und dem Zugriff, den Sie erteilen. Benennen Sie sie nach dem System, für das sie
sind ("ERP-Nachtimport" statt "Test"): Dieser Name erscheint im Prüfprotokoll,
sobald die Integration etwas schreibt.

Beim Erstellen entstehen eine **Client-ID**, die die Zugangsdaten identifiziert
und gefahrlos angezeigt werden darf, und ein **Client-Secret**, mit dem das
System nachweist, dass es diese Zugangsdaten besitzt. **Das Secret wird genau
einmal angezeigt**, in dem Dialog direkt nach dem Erstellen, und nichts kann es
erneut anzeigen - es ist nirgends so gespeichert, dass jemand es zurücklesen
könnte, auch kein Admin. Geht es verloren, erneuern Sie das Secret. Der Dialog kopiert beide einzeln oder zusammen als Umgebungsvariablen
`OVIDENS_CLIENT_ID` und `OVIDENS_CLIENT_SECRET`, und **Ich habe es gespeichert**
schließt ihn und verwirft das Secret von der Seite.

Geben Sie beides an die Person weiter, die die Integration baut, zusammen mit
einem Link: [Automation API](./overview) (auf Englisch). Alles Weitere - wie
sich das System anmeldet, welche Endpunkte es aufruft, wie die Datei aussehen
muss - steht dort.

## Was die Zugriffsoptionen bedeuten [#was-die-zugriffsoptionen-bedeuten]

Jede Option erteilt genau eine Art von Arbeit und sonst nichts. Neben der
Beschriftung zeigt die Auswahl den technischen Namen, den die Option in der API
trägt - nach diesem Namen fragt die Person, die die Integration baut.

| Zugriff                                 | Was das System damit darf                                                |
| --------------------------------------- | ------------------------------------------------------------------------ |
| **Workspace lesen**                     | Apps, Knoten und deren Konfiguration auflisten.                          |
| **Daten schreiben**                     | Zeilen eines Datensatzes importieren und ändern.                         |
| **Indikatorwerte schreiben**            | Erhobene Indikatorwerte eintragen und leeren.                            |
| **Veröffentlichte Pipelines ausführen** | Die veröffentlichte Konfiguration einer App ausführen.                   |
| **Entwürfe ausführen**                  | Unveröffentlichte Konfiguration ausführen, die noch niemand geprüft hat. |
| **Ergebnisse lesen**                    | Ergebnisse eines Durchlaufs abfragen und exportieren.                    |
| **Veröffentlichen**                     | Ändern, was jede Person in diesem Workspace sieht.                       |

Zwei Kennzeichen sagen Ihnen, wie diese Liste zu lesen ist:

* **Erweitert** markiert eine Option, die über das Lesen und das Ausführen der
  **veröffentlichten** Konfiguration hinausgeht - einen ungeprüften Entwurf
  ausführen oder veröffentlichen und damit ändern, was alle sehen. Neue
  Zugangsdaten bringen so etwas nie mit; erteilen Sie es nur, wenn das System
  es wirklich braucht.
* **Noch ohne Wirkung** markiert eine Berechtigung, die derzeit nirgends
  geprüft wird. Sie lässt sich erteilen, speichern und anzeigen, ändert aber
  nichts, was ein Admin beobachten könnte. Das Kennzeichen verschwindet,
  sobald die Option zu wirken beginnt.

**Zugriff bearbeiten** ändert die Berechtigungen bestehender Zugangsdaten. Es
muss nichts neu ausgestellt werden: Die Änderung gilt ab der nächsten Anfrage,
und ein Entzug wirkt auch auf ein bereits ausgestelltes Token.

## Das Secret erneuern [#das-secret-erneuern]

**Secret erneuern** stellt ein zweites Secret aus, ohne dass etwas ausfällt:
Das heute verwendete funktioniert neben dem neuen weiter, Sie können das neue
also in Ruhe ausrollen. Mehr als zwei Secrets gibt es nie, deshalb zieht erst
die **nächste** Erneuerung das ältere zurück - zweimal zu erneuern ist also das
bewusste "Das alte Secret gilt nicht mehr", und der Dialog sagt das vor dem
Bestätigen.

Erneuern Sie, wenn ein Secret nach außen gelangt sein könnte, wenn die Person
geht, die die Integration eingerichtet hat, bevor die Zugangsdaten ablaufen,
oder in dem Rhythmus, den Ihre Richtlinie vorgibt. Die Details zeigen, wann das
aktuelle Secret erstellt wurde und wann das vorherige zuletzt verwendet wurde -
so sehen Sie das alte Secret verstummen, bevor Sie es zurückziehen.

Eine Erneuerung setzt außerdem ein **neues Ablaufdatum** - der Dialog fragt wie
beim Erstellen nach der Laufzeit - und gilt als Bestätigung des Zugriffs (siehe
unten).

## Ablauf und Bestätigung des Zugriffs [#ablauf-und-bestätigung-des-zugriffs]

Alle Zugangsdaten **laufen ab**, spätestens 365 Tage nach dem Erstellen oder der
letzten Erneuerung. Ab dem Ablaufdatum wird das verbundene System abgelehnt, und
der einzige Weg zurück ist, das Secret zu **erneuern**, was ein neues
Ablaufdatum setzt. Erneuern Sie vorher, fällt nichts aus.

Alle **90 Tage** muss außerdem jemand, der Zugangsdaten verwaltet, sie
**bestätigen**: also bestätigen, dass das System den Zugriff, den es hat, noch
braucht. **Bestätigen** im Menü der Zugangsdaten listet ihren Zugriff. Sie
können nur Zugriff behalten, den Sie selbst im gesamten Workspace haben; was
Sie nicht haben, ist deshalb nicht angehakt und wird beim Bestätigen entfernt.
Entfernen Sie auch den Haken bei allem anderen, was das System nicht mehr
braucht. Hinzufügen können Sie auf diesem Weg nichts - das macht **Zugriff
bearbeiten**.

Bestätigen darf jede Person, die Zugangsdaten verwaltet, ob sie sie ausgestellt
hat oder nicht - Zugangsdaten, deren ausstellende Person gegangen ist, bestätigt
also, wer ihren Zugriff abdeckt, und sie behalten nur den Zugriff, den diese
Person hat. Nichts an den Zugangsdaten hängt davon ab, dass die ausstellende
Person noch Mitglied ist.

Wird eine Bestätigung versäumt, funktionieren die Zugangsdaten noch **14 Tage**
weiter, markiert mit **Bestätigung überfällig**. Danach sind sie **Gesperrt**:
Das System wird abgelehnt, bis jemand sie bestätigt, was sie sofort wieder
freigibt. Erstellen oder Erneuern gilt als Bestätigung.

Die Tabelle der Zugangsdaten zeigt, wann sie ablaufen oder als Nächstes bestätigt
werden müssen, und markiert sie **30 Tage** vor jedem der beiden Termine; die
Details nennen außerdem, wer sie zuletzt bestätigt hat. Solange Zugangsdaten Aufmerksamkeit brauchen, sieht
außerdem jede Person, die Zugangsdaten verwaltet, auf der Seite **Apps** einen
Hinweis mit einem Link hierher. Eine E-Mail dazu gibt es nicht - achten Sie
also auf diesen Hinweis.

Ein verbundenes System erfährt, welcher der beiden Gründe es gestoppt hat -
siehe die Fehlercodes in [Automation API](./overview) (auf Englisch) - und kann
beide Termine vorab abfragen.

## Erkennen, ob es funktioniert [#erkennen-ob-es-funktioniert]

Vier Stellen geben Auskunft, jede auf eine andere Frage:

* Der Tab **Zugriff** in den Details der Zugangsdaten sagt, was die Zugangsdaten dürfen: jede
  Berechtigung, die ihre Zugriffsoptionen geben, und welche Option sie jeweils gibt. Sie haben
  keine Rolle und wirken deshalb in jedem gemeinsamen Bereich und jeder App darin, auch in später
  angelegten Apps, und nie im persönlichen Bereich einer Person. Widerrufene Zugangsdaten können
  nichts mehr.
* **Die Tabelle der Zugangsdaten** sagt, ob die Zugangsdaten überhaupt verwendet
  werden. **Zuletzt verwendet** ist der Zeitpunkt der letzten Anmeldung und
  steht auf "Nie verwendet", bis der erste erfolgreiche Aufruf eingegangen ist.
  Das prüft man bei einer neuen, stummen Integration zuerst.
* **Aktivität** sagt, wie viel das System tut und was es herausgeholt hat
  (siehe unten).
* **Das Prüfprotokoll** sagt, was es tatsächlich geändert hat: Öffnen Sie die
  App **Audit Analytics**, gehen Sie auf **All actions** (Alle Aktionen) und
  filtern Sie die **Akteur-Art** auf **Integration**. Der **Akteur** einer
  maschinellen Schreiboperation ist die Integration selbst, unter dem Namen
  ihrer Zugangsdaten, nicht der Admin, der sie ausgestellt hat. Siehe
  [Audits](../../administration/audit-trail.mdx).

Die Ereignisse zu den Zugangsdaten selbst - erstellt, Secret erneuert, Zugriff
geändert, bestätigt, widerrufen - stehen im selben Protokoll und sind dem Admin
zugeschrieben, der sie ausgeführt hat. Dass Zugangsdaten abgelaufen oder
gesperrt sind, steht ebenfalls darin, der Plattform zugeschrieben, weil niemand
es ausgeführt hat.

Läufe werden dort zugeordnet, wo Sie sie suchen würden: In der **Historie**
einer App trägt ein Lauf, den ein verbundenes System gestartet hat, dessen
Namen daneben, auch nachdem die Zugangsdaten widerrufen wurden. Ein Lauf ohne
Markierung wurde von einer Person oder der Assistenz gestartet - oder er ist so
alt, dass der Protokolleintrag, aus dem die Markierung stammt, nicht mehr
vorliegt.

## Was eine Integration tatsächlich getan hat [#was-eine-integration-tatsächlich-getan-hat]

Der Tab **Aktivität** in den Details von Zugangsdaten hat drei Teile.

**Anfragelimit** ist die Zahl der Anfragen pro Minute, die diese Zugangsdaten
stellen dürfen. Anfragen darüber hinaus werden bis zum Beginn der nächsten
Minute abgelehnt, und dem System wird gesagt, wie lange es warten soll. Diese
Zahl nennen Sie, wenn die Integration gedrosselt wird.

**Volumen der letzten 30 Tage** zählt gestartete Läufe, erzeugte Exporte samt
ihrer Zeilen und Datenmenge sowie angewendete Importe samt geschriebener
Zeilen. Ein fehlgeschlagener Import wird nicht gezählt. Das sind **Mengen,
keine Kosten** - Rechenzeit wird für den Workspace als Ganzes gemessen, der Tab
**Nutzung** bleibt also die Stelle für den Verbrauch -, aber eine Integration,
deren Exportzeilen sich verdoppelt haben, ist der erste Ort, an dem man bei
einer steigenden Rechnung nachsieht.

**Was diese Integration herausgeholt hat** listet ihre Exporte auf, neueste
zuerst: wann, welche App und welche Ausgabe, aus welchem Lauf die Datei stammt,
wie viele Zeilen und wie groß, und ob es erfolgreich war. Ein Export ist ein
Lesevorgang und erscheint deshalb nicht im Prüfprotokoll - diese Liste
beantwortet die Frage, ob eine Integration etwas herausgeholt hat, was sie
nicht sollte, und wann. Ein Sternchen bedeutet, dass die Datei am Größenlimit
abgeschnitten wurde und nur einen Teil der Ausgabe enthält; "Datei entfernt"
bedeutet, dass der Export erfolgreich war, die Datei aber inzwischen aufgeräumt
wurde (Dateien nach Tagen, der Eintrag bleibt 90 Tage); und wer den Status
**Fehlgeschlagen** überfährt, sieht den Grund, den die Plattform festgehalten
hat.

## Widerrufen [#widerrufen]

**Widerrufen** setzt Zugangsdaten sofort außer Kraft, auch bereits ausgestellte
Token: Die nächste Anfrage wird abgelehnt. Das lässt sich nicht rückgängig
machen - den Zugriff wiederherzustellen heißt, neue Zugangsdaten auszustellen
und dem System das neue Secret zu geben.

Widerrufene Zugangsdaten bleiben in der Liste, markiert mit **Widerrufen** und
mit nichts mehr zu ändern, nur ihr Schlüssel lässt sich noch kopieren, und sie behalten ihren Namen im Prüfprotokoll - so
bleibt lesbar, was sie getan haben, solange sie gültig waren.
