Öffentliche API

Eine Server-zu-Server-Verwaltungs-API für Ihr Submeto-Konto.

Für jeden aktiven Submeto-Nutzer verfügbar, auch im kostenlosen Tarif. Der Zugriff auf die öffentliche API ist standardmäßig deaktiviert und muss nach Prüfung der Sicherheitsrisiken im Dashboard aktiviert werden.

Für Server, nicht für Browser entwickelt

Die öffentliche API ist für Automatisierungen gedacht, die auf von Ihnen kontrollierter Infrastruktur laufen – Cron-Jobs, Backends und CI-Pipelines. Sie verwaltet Formulare und Felder und liest und verarbeitet Einsendungen. Sie ist getrennt von der Formularübermittlungs-API, die Formulardaten von Website-Besuchern empfängt; wenn Sie das benötigen, beginnen Sie mit deren Dokumentation.

Was Sie tun können

Jede Operation wird durch die Scopes Ihres API-Schlüssels und die Formulare autorisiert, für die der Schlüssel freigegeben ist.

  • Formulare verwalten – auflisten, erstellen, aktualisieren und löschen, gesteuert durch die Scopes forms:read, forms:create, forms:update und forms:delete.
  • Felder definieren – die Feldkonfiguration eines Formulars mit den Scopes forms:read und forms:update lesen und aktualisieren.
  • Einsendungen lesen – Einsendungen pro Formular auflisten und mit den Scopes submissions:read und submissions:mark_read als gelesen markieren.
  • Auf Dateien zugreifen – autorisierten, kurzlebigen Download-Zugriff auf Dateien in Einsendungen erhalten.
  • Workflows bedienen – Entwürfe prüfen und bearbeiten, Versionen validieren und veröffentlichen, Trockentests ausführen, Läufe prüfen und zulässige Fehler erneut versuchen.

Sicherheitsgrenzen

  • API-Schlüssel authentifizieren Ihren Server, niemals einen Browser oder eine mobile App. Verwenden Sie sie nur in Server-zu-Server-Runtimes über HTTPS.
  • Schlüssel tragen ausgewählte Scopes und können nur für ausgewählte Formulare freigegeben werden. Nicht freigegebene Ressourcen sind für den Schlüssel unsichtbar.
  • Antworten enthalten keine Geheimnisse, Formular-Tokens, Integrationskonfigurationen oder rohen Einsendungspayloads.
  • Destruktive Operationen erfordern zusätzlich zu den Scopes eine Bestätigung auf Anwendungsebene.