Eine externe Anwendung per API anbinden
Ihr Ziel
Eine Website, App oder ein Fachverfahren soll Daten der Plattform abrufen oder Inhalte anlegen.
„API-Clients“ öffnen
Das brauchen Sie
- Sie sind Administrator.
- Die Entwickler der Anwendung warten auf den Zugang.
So geht’s
- Öffnen Sie unter „API“ die „API-Clients“ und klicken Sie auf „Neuen API-Client erstellen“.
- Vergeben Sie einen Namen, der den Zweck beschreibt, etwa „Website-Frontend“.
- Wählen Sie die „Zugriffsstufe“.
- Legen Sie mit „Systembenutzer verwenden“ fest, unter welchem Namen angelegte Inhalte erscheinen. Klicken Sie auf „Erstellen“.
- Die Seite des Clients zeigt das „Authentifizierungstoken“. Geben Sie es an die Entwickler weiter, zusammen mit dem Link „API-Dokumentation“ aus der Liste der Clients.
Die Entscheidungen
- Nur lesen oder auch schreiben?
- „Öffentliche Daten“ liest nur öffentliche Inhalte, etwa für ein Widget auf Ihrer Website. „Admin“ darf Inhalte auch anlegen, ändern und löschen. Wählen Sie „Admin“ nur, wenn die Anwendung wirklich schreiben muss.
- Unter welchem Namen erscheinen Inhalte?
- Mit „Systembenutzer verwenden“ unter dem Systemnutzer der Plattform. Ohne den Schalter bekommt der Client einen eigenen Service-Benutzer mit Mailadresse, Namen und Profilbild.
Stolpersteine
Wer den Token hat, hat den Zugang des Clients. Ist er in falsche Hände geraten, klicken Sie beim Client auf „Token erneuern“. Der alte Token gilt dann nicht mehr, auch nicht für die eigene Anwendung.
Mit dem Service-Benutzer meldet sich niemand an. Er dient nur als Autor der Inhalte.
Was ein Client abruft, sehen Sie in den „API-Anfragen-Logs“, gefiltert nach Client, Pfad, Status und Zeitraum.