API-Dokumentation
Öffnen Sie API-Doku in der Navigation. Links wählen Sie einen Endpunkt; rechts sehen Sie seine Beschreibung und können eine Anfrage an diese Instanz senden. Das zugrunde liegende OpenAPI-3.1-Dokument ist unter /api/v1/openapi.json verfügbar. Bei geschützten Endpunkten können Sie ein Bearer-Token für die einzelne Anfrage eingeben. Es wird nicht gespeichert.
Umfrage-API
/api/v1/polls umfasst Termin-, Ganztags- und Textumfragen, Optionen, Teilnehmende,
Einladungen, Stimmen, Kommentare, Ergebnisse sowie CSV-/XLSX-Exporte. Das OpenAPI-Dokument
ist die Referenz für jeden Endpunkt. Persönliche API-Tokens werden je Operation auf den
erforderlichen Scope geprüft; eine Instanz-Administration verleiht keine fremden
Umfragerechte.
Verwenden Sie das für den Aufruf vorgesehene Credential:
- Eine angemeldete Sitzung oder ein
Authorization: Bearer-Token handelt als zugehöriger Account. Ist ein Bearer-Header vorhanden, hat er Vorrang; ein ungültiges Token wird nicht durch eine Cookie-Sitzung ersetzt. x-poll-public,x-poll-invitationundx-poll-capabilitysind getrennte, undurchsichtige Links. Geben Sie sie nicht in URLs, Logs oder geteilte Diagnosedaten.- Ein persönlicher Bearbeitungslink kann gegen eine begrenzte Gast-Sitzung getauscht werden.
Browser verwenden dafür das HttpOnly-Cookie
tempi-guest, API-Clientsx-poll-guest-session. Es ist an genau eine Umfrage und einen Teilnehmer gebunden, nicht an den angemeldeten Account.
Sichere Wiederholungen und Änderungen
Jeder in der API mit Idempotency-Key dokumentierte Schreibaufruf benötigt einen eindeutigen,
vom Client erzeugten Schlüssel. Wiederholen Sie nach einer unterbrochenen Antwort nur dieselbe
Anfrage mit demselben Schlüssel; ein anderer Inhalt unter diesem Schlüssel wird abgewiesen.
Die erste Antwort beim Erstellen einer Umfrage und persönlich gebundene Teilnahmen lassen sich
sicher wiederholen, ohne Klartext-Linksecrets zu speichern. Öffentliche Teilnahmen liefern
bei Wiederholung absichtlich keine Bearbeitungs- oder Sitzungssecrets erneut – starten Sie bei
deren Verlust einen neuen autorisierten Ablauf.
Änderungen an Umfragen und Optionen verlangen If-Match: "rev-N" mit der aktuellen Revision.
Eine veraltete Revision erhält 412. Vor dem Ändern oder Löschen einer bereits gewählten
Option senden Sie X-Acknowledge-Votes: true; so bleibt die Auswirkung auf Stimmen
ausdrücklich. Cookie-basierte Schreibzugriffe benötigen einen Origin, der zur konfigurierten
öffentlichen URL der Instanz passt.
Bei Fehlern prüfen Sie die RFC-9457-Problem-Details-Antwort und Ihre Berechtigung. Exportdaten werden durch dieselbe Sichtbarkeits-Policy wie die API gefiltert; formelaktive Texte werden in CSV maskiert und in XLSX als Literalwerte geschrieben.
Dokument erneut laden
Wenn das OpenAPI-Dokument nicht geladen werden kann, wählen Sie Erneut laden. Die Aktion lädt nur das Schema erneut. Sie sendet keine zuvor eingegebene API-Anfrage und wiederholt keinen Schreibaufruf. Bleibt der Fehler bestehen, können Sie die Aktion später erneut versuchen.
Bildbeispiele
