API-referanse

Alle operasjonene i vbeslag API v1, laget fra det samme dokumentet som API-et sjekker med. Hver operasjon har sin egen side med rettigheter, felt, svar, feilkoder og et eksempel i cURL, Node og PHP.

Nøkkelen

Send nøkkelen i Authorization: Bearer <nøkkel>, aldri i adressen. Verkstedet lager den under Innstillinger › Koblinger (API). En testnøkkel begynner med vb_test_ og lager testordre med egne nummer (T-…); en ekte nøkkel begynner med vb_live_. Hold nøkkelen på serveren, aldri i nettleseren. Mer under Nøkler og tilgang, og prøv trygt i sandkassen.

Reglene i kort form

• Prøv igjen trygt. POST /orders og POST /customers krever Idempotency-Key. Bruk en ny UUID per handling, og den samme når du prøver igjen. Se Regler.
• Versjonen du så. PATCH /orders/{number} krever If-Match med versjonen du så ("v3"). En gammel versjon svarer 409 stale_version. Se Regler.
• Lister. Lister svarer { data, nextCursor }. Synkroniser med sort=updatedAt, updatedSince og cursor, eller bruk webhooks og GET /events. Se Regler.
• Penger i øre. Beløp er hele øre med «Ore» til slutt (unitPriceOre: 61200 er 612 kr). Moms er basispunkter: vatBp: 2500 er 25 %. Se Begreper.
• Feil. Alle feil har samme form. Velg handling etter code, aldri etter message: teksten kan endres. Se Feil.
• Grenser. Per nøkkel: lesing 120, skriving 30, priser 60 og filer 10 kall i minuttet. Over grensen svarer vi 429 rate_limited med Retry-After. Se Grenser.
• Nye felt. Felt vi ikke kjenner i det du sender, gir 400 invalid_request. Svarene kan få nye felt: les bare de du kjenner.

Alle operasjonene

OpenAPI-dokumentet