API-oversigt
API'et er REST over HTTPS. Alle rutenavne starter med en version.
Områder#
| Område | Bruges af | Adgang |
|---|---|---|
/v1/store/* | Storefronts | Publishable key (x-publishable-key) |
/v1/admin/* | Backoffice | Medarbejder-token |
/v1/platform/* | Oprettelse af shops og platformens opsætning | Offentlig eller privilegeret, afhængigt af ruten |
Kunders ordre-links og kvitteringer bruger en ordre-token. Et sundhedstjek findes på /health.
Principper#
- Versionering:
/v1ændres kun additivt. Nye felter og ruter kan komme; eksisterende ændrer ikke betydning. - Penge er hele tal i mindste enhed (
...Minor); moms er i basispoint. - Idempotens: checkout kræver en idempotens-nøgle.
- Serveren er sandheden: totaler, lager og betalingsstatus beregnes af API'et.
- Fejl returneres som afvisninger med en kode.
Reference#
Udkast
Der findes endnu ingen komplet OpenAPI-spec. Den er planlagt sammen med en typet SDK Planlagt. Indtil da er siderne under Byg en storefront den bedste beskrivelse af flowet.
Eksempler fra platformen#
| Rute | Formål |
|---|---|
GET /v1/store/shop | Shoppens offentlige oplysninger |
GET /v1/store/regions | Regioner for markedet |
GET /v1/store/regions/:code/localities | Kommuner i en region |
POST /cart/shipping-options | Leveringsmuligheder for en kurv |
GET /orders/:token/receipt.pdf | Kvittering som PDF |
POST /auth/google, GET /auth/config | Google-login til kunder |
GET /v1/platform/markets | Markeder, en ny shop kan vælge |