API-oversikt

Endepunkt

Alle forespørsler sendes til én URL via POST. Send metodenavnet og parametrene som JSON.

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

Autentisering

Send API-tokenet ditt som et bearer-token i Authorization-headeren. Tokens er koblet til et arbeidsområde — opprett dem fra OAuth og API-nøkler i sidepanelet.

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

Forespørselsformat

Hver forespørsel er et JSON-objekt med to felter:

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

Svarformat

Hvert svar er et JSON-objekt med et ok-felt. Ved suksess:

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

Feil

Ved feil er ok lik false, og et error-objekt inneholder en maskinlesbar kode og en menneskelig lesbar melding:

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

Vanlige feilkoder:

• VALIDATION_ERROR (400) — ugyldige eller manglende parametere

• UNAUTHORIZED (401) — manglende eller ugyldig API-token

• UPGRADE_REQUIRED (402) — funksjonen krever et høyere abonnementsnivå

• FORBIDDEN (403) — tokenet mangler tilgang til ressursen

• CONFLICT (409) — ressursstatuskonflikt, for eksempel et duplikert navn

• NOT_FOUND (404) — ressursen finnes ikke

• METHOD_NOT_FOUND (404) — ukjent metodenavn

• RATE_LIMITED (429) — for mange forespørsler

• INTERNAL_ERROR (500) — uventet serverfeil

Hastighetsbegrensninger

API-forespørsler er begrenset til 120 forespørsler per minutt per token. Overskrides grensen, returneres 429 Too Many Requests.

Neste steg