API-Verbindungen
Über API-Verbindungen bindest du externe Dienste an. In einem Assistenten wählst du den Anbieter aus und trägst die Zugangsdaten ein. Danach siehst du alle Verbindungen in einer Liste und kannst jederzeit prüfen, ob sie funktionieren.
Neue API-Verbindung hinzufügen
- Öffne in den Einstellungen die Seite API-Verbindungen.#
Du siehst die Übersicht deiner bestehenden Verbindungen.
- Klicke oben auf Verbindung hinzufügen.#
Das Fenster „Neue API-Verbindung“ öffnet sich.
- Wähle im Schritt Anbindung wählen die externe Schnittstelle aus dem Katalog.#
Zu jedem Anbieter siehst du Logo, Beschreibung und seine Funktionen. Die Anbieter sind Kategorien zugeordnet. Der Name des Anbieters wird automatisch als Name der Verbindung übernommen, solange du noch keinen eigenen Namen eingetragen hast.
- Wechsle zum Schritt Verbindung konfigurieren.#
Hier hinterlegst du Zugangsdaten und Einstellungen. Ohne ausgewählten Anbieter kommst du nicht weiter.
- Prüfe das Pflichtfeld Name und passe es bei Bedarf an.#
Der Name darf höchstens 255 Zeichen lang sein.
- Trage im Bereich Zugangsdaten die Daten ein, die der gewählte Anbieter verlangt.#
Welche Felder hier erscheinen, hängt vom Anbieter ab.
- Fülle den Bereich Einstellungen aus, falls er angezeigt wird.#
Diesen Bereich gibt es nur bei Anbietern, die zusätzliche Einstellungen haben.
- Schließe den Assistenten ab, um die Verbindung zu speichern.#
Du bekommst die Meldung „API-Verbindung angelegt.“ und die Verbindung erscheint in der Übersicht.
API-Verbindung testen
- Öffne in den Einstellungen die Seite API-Verbindungen.#
- Suche in der Übersicht die Verbindung, die du prüfen möchtest.#
- Klicke in dieser Zeile auf die Aktion Testen.#
Die Aktion wird nur als Symbol mit zwei kreisförmigen Pfeilen angezeigt.
- Lies die Meldung zum Ergebnis.#
Hat der Test geklappt, erscheint „Verbindung erfolgreich.“. Ist er fehlgeschlagen, erscheint „Verbindung fehlgeschlagen.“. Teilt der Anbieter eine genauere Rückmeldung mit, siehst du stattdessen diese.
Übersicht „API-Verbindungen“
Die Seite API-Verbindungen findest du in den Einstellungen. Dort stehen alle Verbindungen in einer Tabelle auf einer einzigen Seite, ohne Seitenumbruch.
- Vor jeder Zeile siehst du das Logo des Anbieters.
- Anbindung: der Anbieter, mit dem die Verbindung besteht.
- Name: der Name, den du der Verbindung gegeben hast.
- Status: der aktuelle Zustand der Verbindung als farbige Anzeige. Bei einem Fehler ist sie rot, und wenn du mit der Maus darüberfährst, siehst du die letzte Fehlermeldung.
- Capabilities: die Funktionen, die der Anbieter bereitstellt.
In jeder Zeile gibt es drei Aktionen, die nur als Symbole angezeigt werden: Testen, Bearbeiten und Löschen. Gibt es noch keine Verbindung, siehst du den Hinweis „Noch keine API-Verbindungen“ mit der Aufforderung „Lege eine neue Verbindung über den Button oben an.“
Fenster „API-Verbindung bearbeiten“
Über die Bearbeiten-Aktion in der Zeile einer Verbindung öffnest du das Fenster „API-Verbindung bearbeiten“. Dort änderst du das Pflichtfeld Name sowie die Bereiche Zugangsdaten und – falls vorhanden –Einstellungen. Den Anbieter kannst du hier nicht ändern. Nach dem Speichern wird die Verbindung automatisch erneut getestet.
Häufige Fragen
Warum kann ich einen Anbieter im Katalog nicht auswählen?
Diesen Anbieter kannst du nur einmal einrichten, und es gibt schon eine Verbindung dazu. Du erkennst das am Hinweis „Bereits konfiguriert (nur eine Instanz möglich).“.
Muss ich eine neue Verbindung selbst testen?
Nein. Nach dem Anlegen und nach dem Bearbeiten wird die Verbindung automatisch getestet. Mit der Aktion Testen kannst du den Test aber jederzeit erneut starten.
Kann ich bei einer bestehenden Verbindung den Anbieter wechseln?
Nein. Im Fenster „API-Verbindung bearbeiten“ änderst du nur den Namen, die Zugangsdaten und die Einstellungen. Für einen anderen Anbieter legst du über Verbindung hinzufügen eine neue Verbindung an.
Wo sehe ich, warum eine Verbindung nicht funktioniert?
Fahr bei einer Verbindung mit Fehlerstatus mit der Maus über die Statusanzeige. Dann siehst du die letzte Fehlermeldung. Bei einem manuellen Test zeigt dir die Ergebnismeldung ebenfalls den Grund, sofern der Anbieter einen mitteilt.