Zum Inhalt springen

API-Schlüssel erstellen

Anleitung · Web

Nur Web Mit einem API-Schlüssel greift ein anderes System, etwa ein Lohnprogramm oder ein BI-Werkzeug, über die REST-API auf Daten Ihrer Organisation zu. Sie brauchen die Berechtigung Administrator.

  1. Öffnen Sie Einstellungen → Integrationen und klicken Sie unter API-Schlüssel auf Schlüssel erstellen.

    Der Abschnitt API-Schlüssel mit der Schaltfläche Schlüssel erstellen

  2. Geben Sie einen Name ein, an dem Sie das System erkennen, zum Beispiel Lohnbuchhaltung. Wählen Sie bei Bedarf ein Datum unter Gültig bis. Ohne Datum läuft der Schlüssel nicht ab.

  3. Klicken Sie auf Erstellen, kopieren Sie den Schlüssel mit Kopieren und tragen Sie ihn im anderen System ein. Schließen Sie den Dialog über das Kreuz oben rechts.

  4. Ein neuer Schlüssel darf noch nichts. Klicken Sie in seiner Zeile auf 0 Rechte ausgewählt.

  5. Aktivieren Sie unter Erlauben jede Berechtigung, die das System braucht. Lässt sich eine Berechtigung auf Teams beschränken, wählen Sie unter Anwendungsbereich die Teams, deren Daten das System sehen soll; ohne Auswahl gilt sie für die ganze Organisation. Klicken Sie auf Speichern.

    Der Dialog mit den Berechtigungen eines API-Schlüssels

Mit Nachrichten senden schickt das System E-Mails und Push-Benachrichtigungen mit eigenem Text an Mitarbeiter, etwa den Hinweis auf verfallenden Resturlaub. Mitarbeiter erhalten sie wie jede Benachrichtigung von Teamanda, und das Protokoll vermerkt jede Nachricht mit dem Namen des Schlüssels.

Teamanda zeigt den Schlüssel nur dieses eine Mal. Geht er verloren, widerrufen Sie ihn und erstellen einen neuen. Wie das andere System den Schlüssel verwendet, steht in der API-Dokumentation neben API-Schlüssel.