Für Administratoren
API-Verbindungen
Unter API-Verbindungen richtest du Verbindungen zu externen Systemen ein. Du wählst in einem Assistenten den Anbieter aus, hinterlegst die Zugangsdaten und prüfst, ob die Verbindung funktioniert.
Die Seite findest du in den Einstellungen. Deine bestehenden Verbindungen stehen dort in einer Tabelle mit den Spalten Anbindung, Name, Status und Capabilities. Gibt es noch keine Verbindung, siehst du den Hinweis „Noch keine API-Verbindungen“.
Neue API-Verbindung hinzufügen
- Öffne in den Einstellungen die Seite API-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 eine Beschreibung und seine Funktionen. Die Anbieter sind nach Kategorien gruppiert. Der Name des Anbieters wird automatisch als Name der Verbindung übernommen.
- Wechsle zum Schritt Verbindung konfigurieren.#
- 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 Tabelle.
API-Verbindung testen
- Öffne in den Einstellungen die Seite API-Verbindungen.#
- Suche in der Tabelle 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 einen genaueren Grund mit, siehst du stattdessen diesen.
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.