API-Übersicht

Endpunkt

Alle Anfragen gehen über POST an eine einzige URL. Übergib den Methodennamen und die Parameter als JSON.

POST https://api.formbase.so/api/v1

Authentifizierung

Übergib deinen API-Token als Bearer-Token im Authorization-Header. Tokens sind einem Workspace zugeordnet — erstelle sie unter OAuth und API-Keys in der Seitenleiste.

curl -X POST https://api.formbase.so/api/v1 \
  -H "Authorization: Bearer fb_..." \
  -H "Content-Type: application/json" \
  -d '{"method": "forms.list", "params": {}}'

const res = await fetch('https://api.formbase.so/api/v1', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.FORMBASE_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ method: 'forms.list', params: {} }),
})
const data = await res.json()

import os, requests
res = requests.post(
    "https://api.formbase.so/api/v1",
    headers={"Authorization": f"Bearer {os.environ['FORMBASE_TOKEN']}"},
    json={"method": "forms.list", "params": {}},
)
data = res.json()

Anfrage-Format

Jede Anfrage ist ein JSON-Objekt mit zwei Feldern:

{
  "method": "forms.list",
  "params": {
    "workspaceId": "abc123..."
  }
}

Antwort-Format

Jede Antwort ist ein JSON-Objekt mit einem ok-Feld. Bei Erfolg:

{
  "ok": true,
  "data": { ... }
}

Fehler

Bei einem Fehler ist ok gleich false, und ein error-Objekt enthält einen maschinenlesbaren Code und eine menschenlesbare Meldung:

{
  "ok": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Field 'name' is required."
  }
}

Häufige Fehlercodes:

• VALIDATION_ERROR (400) — ungültige oder fehlende Parameter

• UNAUTHORIZED (401) — fehlender oder ungültiger API-Token

• UPGRADE_REQUIRED (402) — die Funktion erfordert ein höheres Abonnement-Tier

• FORBIDDEN (403) — Token hat keinen Zugriff auf die Ressource

• CONFLICT (409) — Ressourcen-Zustandskonflikt, z. B. ein doppelter Name

• NOT_FOUND (404) — Ressource existiert nicht

• METHOD_NOT_FOUND (404) — unbekannter Methodenname

• RATE_LIMITED (429) — zu viele Anfragen

• INTERNAL_ERROR (500) — unerwarteter Serverfehler

Rate-Limits

API-Anfragen sind auf 120 Anfragen pro Minute pro Token begrenzt. Bei Überschreitung des Limits wird 429 Too Many Requests zurückgegeben.

Nächste Schritte