Zum Inhalt springen

Integrationen

Wie externe Systeme über die öffentliche Schnittstelle und das Webhook-System an decidio anschließen.

Überblick

Eine Gemeinde betreibt selten nur ein System. decidio bietet deshalb zwei Wege für die Anbindung an Drittsoftware: eine öffentliche Schnittstelle für lesende und schreibende Zugriffe sowie ein Webhook-System, das Ereignisse an externe Systeme weiterleitet.

Diese Seite beschreibt die Möglichkeiten auf Konzept-Ebene. Eine ausführliche Referenz mit allen Endpunkten, Datenformaten und Sicherheits-Details folgt in einem späteren Abschnitt — siehe Wie es weitergeht.

Funktionsweise

Die öffentliche Schnittstelle ermöglicht den lesenden und — abhängig von der Berechtigung — schreibenden Zugriff auf Bürgereingaben und ausgewählte Stammdaten. Jede Gemeinde verwaltet die eigenen API-Schlüssel selbst und kann sie gezielt vergeben und widerrufen.

Das Webhook-System informiert externe Systeme, sobald in decidio ein Ereignis eintritt — etwa der Statuswechsel einer Bürgereingabe. Die Empfänger lassen sich pro Gemeinde verwalten; Wiederholungen bei Übertragungsfehlern und ein Schutzmechanismus für die Authentizität der Nachrichten sind integriert.

Beide Wege sind so angelegt, dass eine Fachsoftware der Gemeinde — etwa die bestehende Ratsinformationssoftware oder das Beschwerdemanagement — Eingaben übernehmen und Statuswechsel synchron halten kann.

Häufige Aufgaben

Einen API-Schlüssel erzeugen

  1. In den Einstellungen den Bereich „Integrationen“ öffnen.
  2. Einen neuen Schlüssel anlegen und einen sprechenden Namen vergeben.
  3. Den Schlüssel an die berechtigte Stelle übergeben — er ist nur einmal sichtbar und kann anschließend gezielt eingesetzt werden.

Ein Webhook-Ziel hinterlegen

  1. Im Bereich „Integrationen“ ein neues Webhook-Ziel anlegen.
  2. Die Ereignisse auswählen, die übertragen werden sollen.
  3. Die Empfängeradresse und die Signatur-Einstellungen für das Drittsystem vorbereiten — die Details folgen in der Referenz.

Eine bestehende Anbindung prüfen

In der Übersicht „Integrationen“ den Status der Schlüssel und Webhooks einsehen. Fehler bei der Zustellung werden mit einem Hinweis versehen, damit das betroffene Drittsystem gezielt angesprochen werden kann.

Verwandte Themen

Wie es weitergeht

Die ausführliche Entwickler-Referenz ist verfügbar als API-Referenz und Webhook-Referenz. Die API-Referenz beschreibt Endpunkte, Authentifizierung, Paginierung, Ratenbegrenzung und Fehler. Die Webhook-Referenz zeigt Ereignistypen, Payload, Signaturprüfung und den Zustellvertrag.