Fehlerbehebung
Die häufigsten Probleme unter Organisation › Einstellungen › Entwickler, geordnet nach dem, was du beobachtest – jeder Abschnitt nennt die Ursache und den nächsten Schritt.
Wie du API-Tokens anlegst und verwaltest, steht auf den anderen Seiten unter Entwickler. Probleme mit Webhooks behandelt die Fehlerbehebung zu Webhooks.
Die Gruppe „Entwickler“ fehlt in den Einstellungen
Deine Benutzerrolle hat den Bereich Entwickler nicht freigeschaltet. Eine Person mit passenden Rechten öffnet dafür Organisation › Einstellungen › Team & Rollen › Benutzerrollen und wählt deine Rolle. Im Block Organisation klickt sie die Zeile Einstellungen an (Pfeil am rechten Rand). In den Detail-Rechten dieser Zeile schaltet sie im Abschnitt Entwickler den Schalter Bereich aktiv ein. Ist der Bereich aus, verschwindet die ganze Gruppe samt Webhooks und API aus der Liste links. Dasselbe passiert, wenn im Abschnitt Entwickler die Auswahlfelder Webhooks und API beide auf Kein Zugriff stehen.
Der Menüpunkt für die API-Tokens fehlt
Deiner Benutzerrolle fehlt der Zugriff auf die Einstellungen oder auf die Seite der API-Tokens. Im zweiten Fall steht in den Detail-Rechten der Zeile Einstellungen im Abschnitt Entwickler das Auswahlfeld API auf Kein Zugriff. Eine Person mit Administrator-Rolle gibt das unter Organisation › Einstellungen › Team & Rollen › Benutzerrollen frei. Zum Ansehen genügt Nur lesen, zum Anlegen und Ändern Lesen + Bearbeiten.
Bei einem Token steht „Noch nicht verwendet“
In der Liste unter Organisation › Einstellungen › Entwickler › API steht in der Spalte Zuletzt verwendet Noch nicht verwendet, solange kein Programm den Token benutzt hat. Das ist kein Fehler. Sobald ein Aufruf mit dem Token angekommen ist, stehen dort Datum und Uhrzeit der letzten Nutzung.
Das Fenster mit dem Token ist zu, der Token wird nicht mehr angezeigt
i-Planner zeigt den vollständigen Token genau einmal an. Danach siehst du auf der Bearbeiten-Seite im Bereich Token unter Vorschau nur noch einen Ausschnitt aus Anfang und Ende. Öffne den Token über Organisation › Einstellungen › Entwickler › API und klicke im Bereich Token auf Regenerieren. Dann zeigt dir das Fenster Token regeneriert einen neuen Schlüssel. Der bisherige gilt ab diesem Moment nicht mehr, und du musst ihn im angebundenen Programm ersetzen. Die Schritte stehen unter Token regenerieren.
Die Zeile „Token regenerieren“ fehlt
Deine Benutzerrolle hat für die API-Tokens nur die Stufe Nur lesen. Dann öffnet sich ein Token unter Organisation › Einstellungen › Entwickler › API nur zum Ansehen. Alle Felder sind gesperrt, und im Bereich Token fehlt die Zeile Token regenerieren mit dem Knopf Regenerieren. Zum Regenerieren braucht deine Rolle in den Detail-Rechten der Zeile Einstellungen im Abschnitt Entwickler beim Auswahlfeld API mindestens Lesen + Bearbeiten. Das stellt eine Person ein, die Benutzerrollen bearbeiten darf, unter Organisation › Einstellungen › Team & Rollen › Benutzerrollen.
Statt der Seite steht „Dieser Bereich ist derzeit nicht verfügbar oder nicht freigegeben.“
Die Seite unter Organisation › Einstellungen › Entwickler ließ sich nicht laden, oder deine Benutzerrolle darf sie gerade nicht mehr sehen. Das gilt für API und Webhooks, für die Liste und für einen geöffneten Token oder Webhook. Meist hat jemand deine Rechte geändert, während die Seite offen war. Auf der Seite eines Tokens oder Webhooks lädst du die Seite im Browser neu. In der Liste steht stattdessen „Du hast keine Berechtigung für diesen Bereich.“, „Die Tokens konnten nicht geladen werden.“ oder „Die Webhooks konnten nicht geladen werden.“ Dort klickst du auf Erneut laden. Bleibt die Meldung, fehlt deiner Rolle der Zugriff. Er steht in den Detail-Rechten der Zeile Einstellungen im Abschnitt Entwickler bei den Auswahlfeldern API und Webhooks.
Das Programm erreicht die REST-API nicht
Prüfe zuerst die Adresse, die im anderen Programm hinterlegt ist. Die REST-API hat für alle Organisationen dieselbe Adresse, die Base-URL https://www.api.i-planner.app. Das ist nicht die Adresse, unter der du i-Planner im Browser öffnest. Trage sie genau so ein und achte auf https:// am Anfang, siehe Ein Programm mit der REST-API verbinden. Hinter der Base-URL folgen /v3/ und der Datenbereich, etwa https://www.api.i-planner.app/v3/customers. Antwortet die REST-API mit Fehler 404 und „This API endpoint does not exist.“, stimmt dieser Pfad nicht. Lehnt sie einen Aufruf mit Fehler 401 oder 403 ab, liegt es am Token, siehe Ein Aufruf wird mit „401“ abgelehnt und Ein Aufruf wird mit „403“ abgelehnt.
Ein Aufruf wird mit „403“ abgelehnt
Wird ein Aufruf mit Fehler 403 abgelehnt, prüfe beim Token unter Organisation › Einstellungen › Entwickler › API zwei Dinge. Das erste sind die Berechtigungen. Nur ausdrücklich freigegebene Datenbereiche sind erlaubt. Lege also mit + eine Zeile für den passenden Datenbereich an, oder schalte in der vorhandenen Zeile Lesen oder Schreiben ein. Das zweite sind die IPs. Stehen dort Adressen, nimmt i-Planner Anfragen mit diesem Token nur von diesen Adressen an.
Ein Aufruf wird mit „401“ abgelehnt
Wird ein Aufruf mit Fehler 401 abgelehnt, erkennt i-Planner den Token selbst nicht (mehr) an. Prüfe die Liste unter Organisation › Einstellungen › Entwickler › API. Steht beim Token in der Spalte Status Widerrufen, wurde er deaktiviert. Schalte ihn über Bearbeiten mit Aktiv wieder ein. Steht dort Abgelaufen, ist seine Laufzeit vorbei. Wähle dann unter Gültigkeit eine neue, siehe Gültigkeit. Fehlt der Eintrag ganz, wurde er gelöscht. Andernfalls prüfe, ob der Token zwischenzeitlich über Regenerieren ersetzt wurde und im anderen Programm noch der alte Schlüssel liegt.
Weitere Themen
- API-Tokens: Token anlegen, Berechtigungen, Laufzeit, IP-Liste, regenerieren und deaktivieren.
- Webhooks › Fehlerbehebung: wenn ein Webhook nicht feuert oder sich nicht aktivieren lässt.
- Benutzerrollen: die Rechte für den Bereich Entwickler.
- Audit-Log: die eingehenden API-Aufrufe im Protokoll API.