Skip to Content
Hurtigstart

Hurtigstart

Her er alt du trenger for å koble en nettside eller et system til verkstedets vbeslag: en nøkkel per verksted, JSON over HTTPS, og ordre som havner i samme liste som lappene på verkstedet.

Adressen
https://vbeslag.com/api/v1
Versjon
v1
Format
JSON over HTTPS
OpenAPI
openapi.json

Skal nettsiden bare vise verkstedets nettbutikk? Da trenger du ingen nøkkel og ingen kode herfra. Verkstedet finner koden under Nettbutikk › Innstillinger. Se Nettbutikken på nettsiden.

Kom i gang i fem steg

Lag en testnøkkel

Verkstedet lager nøkkelen under Innstillinger › Koblinger (API) og velger «Test». Den begynner med vb_test_. Hold den på serveren, aldri i nettleseren.

På serveren din
export VBESLAG_KEY="vb_test_…"

Har du ikke et verksted å prøve med? Lag en sandkasse: et testverksted med kunder, beslag og ordrer, og en testnøkkel til deg. Alt om nøkler, test og ekte, står i Nøkler og tilgang.

Sjekk at nøkkelen virker

GET /me viser verkstedet, nøkkelen og hva den har lov til.

GET /me
curl https://vbeslag.com/api/v1/me \
  -H "Authorization: Bearer $VBESLAG_KEY"
Svaret du får
{
  "organization": { "name": "Nordvik Blikk AS", "shopSlug": "nordvik" },
  "key": { "name": "Prøve", "environment": "test", "purpose": "nettside", … },
  "features": { "api": true, "webhooks": true, … },
  "apiVersion": "v1"
}

Send din første forespørsel

Med en testnøkkel får forespørselen nummer T-000001 og vises ikke i verkstedets lister. Idempotency-Key gjør det trygt å prøve igjen: samme nøkkel og samme innhold gir samme svar, aldri to ordre.

POST /orders
curl https://vbeslag.com/api/v1/orders \
  -H "Authorization: Bearer $VBESLAG_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 6f1c2e9a-0d5b-4a7e-9f31-2b8c4d7e1a90" \
  -d '{
    "intent": "request",
    "contact": { "name": "Kari Nordmann", "email": "kari@example.no", "mobile": "+4791234567" },
    "title": "Pipebeslag",
    "note": "Se bilde av skissen",
    "lines": [{ "kind": "text", "description": "Pipebeslag 600x600, stål sort", "quantity": 1, "unit": "stk" }],
    "externalRef": "skjema-1042"
  }'
Svaret du får
HTTP/1.1 201 Created
Location: /api/v1/orders/T-000001
 
{
  "number": 1, "numberDisplay": "T-000001", "isTest": true,
  "status": "forespurt", "statusLabel": "Forespørsel",
  "lines": [{ "lineNo": 1, "kind": "text", "priceStatus": "pending", … }],
  "totals": { "netOre": null, "currency": "NOK", "priceStatus": "partial" },
  "version": 1, …
}

Alle feltene står i POST /orders. En linje uten pris har priceStatus: "pending": Pris kommer. Se Begreper for nummer, statuser og beløp i øre.

Legg ved et bilde av skissen

JPEG, PNG, WebP, HEIC eller PDF, høyst 15 MB per fil og 10 filer per ordre.

POST /orders/{number}/attachments
curl https://vbeslag.com/api/v1/orders/T-000001/attachments \
  -H "Authorization: Bearer $VBESLAG_KEY" \
  -F fil=@skisse.jpg \
  -F type=foto

Se POST /orders/{number}/attachments i referansen.

Få beskjed når noe skjer

Verkstedet legger inn adressen din under Koblinger (API) › Webhooks og trykker «Send testhendelse». Hver beskjed er en POST med disse overskriftene:

En beskjed fra vbeslag
POST /din-adresse HTTP/1.1
Content-Type: application/json
User-Agent: vbeslag-webhooks/1
Vbeslag-Event-Id: evt_01JEX4Q7R2M9T5V8W0Y3Z6A1B4
Vbeslag-Event-Type: order.ready
Vbeslag-Delivery-Attempt: 1
Vbeslag-Signature: t=1797590527,v1=5f2b…c9e1

Sjekk signaturen før du stoler på beskjeden. Koden for Node og PHP står i Webhooks.

Neste steg

Test og ekte, verkstedsnøkkel og kundenøkkel, og hva hver rett gir lov til.

Nøkler og tilgang

Idempotency-Key, If-Match, lister og synkronisering.

Regler

Beskjed når noe skjer, signaturen og nye forsøk.

Webhooks

Formen på en feil og alle feilkodene.

Feil

Prøv API-et uten å være kunde.

Sandkasse

Hver operasjon med rettigheter, felt, svar og eksempel.

API-referanse
Sandkasse