Übersicht

Wofür der Entwickler-Bereich da ist und wann du Webhooks oder API-Tokens brauchst.

Unter Organisation › Einstellungen › Entwickler öffnest du i-Planner nach außen. Du legst fest, welche anderen Programme deine Daten lesen oder schreiben dürfen und worüber i-Planner sie informiert. Für die tägliche Arbeit im Programm musst du hier nichts einstellen. Interessant wird der Bereich erst, wenn eine zweite Software ins Spiel kommt.

Kurz erklärt

Die Gruppe enthält zwei Seiten:

Seite	Wofür	Wer spricht wen an
Webhooks	i-Planner meldet ein Ereignis an eine Adresse deiner Wahl, sobald es eintritt	i-Planner → dein System
API	Die API-Tokens, also Schlüssel, mit denen ein anderes Programm über die REST-API Daten aus i-Planner liest und hineinschreibt	dein System → i-Planner

Typische Aufgaben unter Organisation › Einstellungen › Entwickler:

Ein anderes System soll sofort erfahren, dass ein Kunde angelegt wurde: Webhook anlegen.
Ein Programm soll Daten aus i-Planner holen oder hineinschreiben: Token anlegen.
Ein Kollege soll den Bereich nur ansehen dürfen: Dafür braucht seine Rolle die Stufe Nur lesen, siehe Häufige Fragen.

Voraussetzungen

Deine Benutzerrolle braucht das Recht Einstellungen und in dessen Detail-Rechten im Abschnitt Entwickler den Schalter Bereich aktiv. Fehlt eines von beidem, taucht die Gruppe Entwickler in der Liste links gar nicht auf.
Für Webhooks und API-Tokens muss auf der Gegenseite ein System stehen, das die Daten entgegennimmt oder abruft.

Bereich öffnen

Öffne Organisation › Einstellungen. i-Planner öffnet die erste Seite der Liste, die du sehen darfst, meist Stammdaten.
In der Liste links steht zwischen den Gruppen Vorlagen und Datenverwaltung die Gruppe Entwickler mit den Einträgen Webhooks und API. Hinter API verwaltest du die API-Tokens. Die Seite trägt die Überschrift API und heißt auch in der Benutzerrolle so.

Webhooks

Webhooks sind der richtige Weg, wenn ein anderes System sofort erfahren soll, dass sich in i-Planner etwas geändert hat. Das kann zum Beispiel ein neu angelegter Kunde oder ein aktualisierter Vertrag sein. Du hinterlegst eine Zieladresse, wählst die Ereignisse aus, bei denen i-Planner dorthin sendet, und schaltest den Webhook nach einem erfolgreichen Test ein.

Mehr dazu unter Webhooks.

API-Tokens

API-Tokens sind der richtige Weg, wenn ein anderes Programm von sich aus Daten aus i-Planner holen oder hineinschreiben soll. Du legst einen Schlüssel für die REST-API an. Dabei bestimmst du, welche Datenbereiche er lesen und schreiben darf, welche Laufzeit er hat und von welchen Adressen aus er benutzt werden darf.

Mehr dazu unter API-Tokens.

Häufige Fragen

In der Regel ja. Bei Webhooks muss auf der anderen Seite jemand die Adresse bereitstellen, die die Meldungen von i-Planner entgegennimmt. Bei API-Tokens muss jemand den Schlüssel in seiner Software hinterlegen und die REST-API ansprechen.

Die Richtung. Ein Webhook ist der Anruf von i-Planner nach draußen. Passiert etwas, geht automatisch eine Nachricht an deine Adresse. Ein API-Token ist der Schlüssel für den umgekehrten Weg. Ein anderes Programm meldet sich bei i-Planner und holt sich Daten oder schreibt welche. Beides ist unabhängig voneinander. Du kannst nur eines von beidem einrichten oder beides nebeneinander.

Die Rechte im Bereich Entwickler vergibst du pro Seite. Das geht unter Organisation › Einstellungen › Team & Rollen › Benutzerrollen in den Detail-Rechten der Zeile Einstellungen. Im Abschnitt Entwickler stellst du die Auswahlfelder Webhooks und API einzeln ein. Zur Wahl stehen Kein Zugriff, Nur lesen, Lesen + Bearbeiten und Lesen + Bearbeiten + Löschen. Die Auswahlfelder erscheinen erst, wenn im Abschnitt Entwickler der Schalter Bereich aktiv eingeschaltet ist. Zum Ansehen ohne Ändern wählst du Nur lesen. Dein Kollege sieht in den Listen dann statt Bearbeiten den Eintrag Ansehen.

Weitere Themen

Webhooks: Änderungen aus i-Planner automatisch an ein anderes System melden.
API-Tokens: Schlüssel für die REST-API anlegen, einschränken und widerrufen.
Fehlerbehebung: wenn die Gruppe Entwickler fehlt oder ein API-Aufruf abgelehnt wird.
Benutzerrollen: wer den Bereich Entwickler sieht und darin ändern darf.
Audit-Log: ausgehende Webhook-Zustellungen und eingehende API-Aufrufe in eigenen Protokollen.