Bolio REST API

Bas-URL

Alla anrop görs mot din arbetsyte-URL. Ersätt {workspace} med din identifierare.

https://{workspace}.bolio.app/api/v1

Autentisering

Skicka din API-nyckel i headern Authorization: Bearer <key>. Se Autentisering för hur du skaffar en nyckel.

curl https://{workspace}.bolio.app/api/v1/customers \
  -H "Authorization: Bearer sk_live_..."

Rate limiting

Max 100 anrop per minut per nyckel. Responsen returnerar X-RateLimit-Remaining så du kan anpassa dig.

Felhantering

Fel returneras med lämplig HTTP-status och ett JSON-objekt med field och message. 4xx = klientfel, 5xx = serverfel.

// 422 — validation error
{
  "error": {
    "field": "email",
    "message": "Invalid email format"
  }
}

Paginering

Listor pagineras med cursor. Skicka ?cursor=<token> för nästa sida; en tom cursor betyder inga fler rader.

GET /api/v1/customers?cursor=eyJpZCI6IjEyMyJ9

{
  "data": [...],
  "cursor": "eyJpZCI6IjEyNCJ9"   // null when no more rows
}

Exempel

Skapa en kund:

POST /api/v1/customers
Authorization: Bearer sk_live_...
Content-Type: application/json

{
  "name": "Anna Andersson",
  "email": "anna@example.se",
  "phone": "+46701234567",
  "address": "Storgatan 1, 753 12 Uppsala"
}