Kontakt

← Zurück zur Übersicht

Schnittstellen und Exportformate

Öffentliche, lesende Schnittstellen eines Citivo-Portals (Mängelmelder für Kommunen).

Diese Seite können Sie über den Browser drucken oder als PDF speichern.

Die Spezifikation folgt OpenAPI 3.1; auf jeder Portalinstanz ist zusätzlich die Seite /api-doku verfügbar.

Grundsätze der öffentlichen Lese-API

  • Alle Endpunkte sind lesend (GET) und ohne Authentifizierung nutzbar.
  • Antworten sind JSON (application/json; charset=utf-8).
  • Alle Endpunkte sind rate-limitiert; bei Überschreitung antwortet der Server mit 429 und dem Header Retry-After: 60.
  • Antworten werden serverseitig gecacht (30–60 s, Header X-Cache: HIT|MISS).
  • Personenbezogene Daten werden nicht ausgeliefert; Fotos und Beschreibungen erscheinen nur bei redaktioneller Freigabe und Einwilligung der meldenden Person.
  • Das Erstellen von Meldungen erfolgt über die Weboberfläche (session- und CSRF-gebunden) und ist bewusst nicht Teil dieser Dritt-API.

REST-Endpunkte (OpenAPI 3.1)

EndpunktBeschreibungParameter (Auszug)
/api/meldungen.php Meldungen abrufen (Kartendaten) status, gemeinde, mangelart, suche, days, scope, limit
/api/stats.php Öffentliche Statistiken (Meldungszahlen, Statusverteilung, Erledigungsquote, Top-Mangelarten) —
/api/baustellen.php Baustellen abrufen (leere Liste, wenn Modul deaktiviert) status, strassenklasse, baustellenart, gemeinde, near_lat/lng, radius_km, bbox, limit
/api/gemeinden.php Aktive Gemeinden der Instanz stats=true (ergänzt Meldungs-Statistiken je Gemeinde)
/api/citivo_status.php Installationsstatus (Version, App-Name) für Betreiber-Monitoring; Antwort wird nicht gecacht —
/api/open311/services.json Open311 GeoReport v2 – Service-Liste (aktive Mangelarten); Alias: /api/open311/services.php —
/api/open311/requests.json Open311 GeoReport v2 – Service Requests (öffentliche Meldungen); Alias: /api/open311/requests.php service_request_id, service_code, status, start_date, end_date, limit

Weitere Exportformate und Feeds

FormatStandard / ProtokollVerwendungZugang
Open311 GeoReport v2 Maschinenlesbarer Abruf von Mangelarten und Meldungen; zusätzlich vollständiger Datenexport für Verwaltungen Lesend unter /api/open311/; Export im Admin-Bereich
CAP Common Alerting Protocol 1.2 (NINA/KATWARN/MoWaS) XML-Export im Krisenmodus, Feed-Anbindung warnung.bund.de Krisenmodus je Portal
RSS RSS 2.0 Feeds für Baustellen und weitere Module /feed/
CSV Tabulatorgetrennte Werte Datenexport für Verwaltungen (Meldungen, Stammdaten) Admin-Bereich
GeoJSON GeoJSON (RFC 7946) Geografische Daten für Karten und GIS-Systeme Admin-Bereich und API-Antworten mit Koordinaten
ICS iCalendar Termine und Baustellenzeiträume /feed/
OKSTRA OKSTRA XML Baustelleninformationen für Mobilitätsportale /feed/

Beispielinstanz

Die Demonstrationsumgebung am Beispiel des Landkreises Nordhausen (melder.nordhausen.org) stellt alle oben genannten Schnittstellen live bereit. Beispiel-Endpunkte: