API-overzicht

Endpoint

Alle verzoeken gaan naar één URL via POST. Geef de methodenaam en parameters mee als JSON.

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

Authenticatie

Stuur je API-token mee als bearer token in de Authorization-header. Tokens zijn gekoppeld aan een workspace — maak ze aan via OAuth en API-sleutels in de zijbalk.

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()

Verzoekformaat

Elk verzoek is een JSON-object met twee velden:

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

Antwoordformaat

Elk antwoord is een JSON-object met een ok-veld. Bij succes:

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

Fouten

Bij een fout is ok gelijk aan false en bevat een error-object een machineleesbare code en een leesbare melding:

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

Veelvoorkomende foutcodes:

• VALIDATION_ERROR (400) — ongeldige of ontbrekende parameters

• UNAUTHORIZED (401) — ontbrekend of ongeldig API-token

• UPGRADE_REQUIRED (402) — de functie vereist een hoger abonnementsniveau

• FORBIDDEN (403) — token heeft geen toegang tot de resource

• CONFLICT (409) — resourcetoestandconflict, zoals een dubbele naam

• NOT_FOUND (404) — resource bestaat niet

• METHOD_NOT_FOUND (404) — onbekende methodenaam

• RATE_LIMITED (429) — te veel verzoeken

• INTERNAL_ERROR (500) — onverwachte serverfout

Limieten

API-verzoeken zijn beperkt tot 120 verzoeken per minuut per token. Als je de limiet overschrijdt, krijg je 429 Too Many Requests terug.

Volgende stappen