REST API (Headless)
Guide til Shoporamas REST API. Integrer med lagersystemer, regnskabsprogrammer og eksterne apps via API-nøgler med fuld adgang til produkter, ordrer og kunder.
Shoporamas REST API giver dig mulighed for at integrere din webshop med eksterne systemer som lagerstyring, regnskab, PIM-systemer og andre apps. API'et understøtter fuld CRUD-funktionalitet på produkter, ordrer, kunder, kategorier og meget mere.
Opret en API-nøgle
- Gå til Indstillinger → API i administrationen
- Klik Tilføj adgang
- Giv nøglen et navn (fx "Lagersystem" eller "Regnskab")
- Vælg adgangsniveau: Alle (læs/skriv), Kun læse eller Kun skrive
- Sæt eventuelt en daglig grænse for antal API-kald
- Gem — din API-nøgle vises nu
Sådan bruges API'et
Alle kald sendes til /REST/ med din API-nøgle i headeren:
Authorization: din-api-nøgle
Data sendes og modtages som JSON med Content-Type: application/json.
Tilgængelige endpoints
API'et dækker alle vigtige dele af din webshop:
- Produkter — Opret, opdater, hent og slet produkter med billeder, varianter og lagerstatus
- Kategorier — Administrer din kategoristruktur
- Ordrer — Hent ordrer, opdater status, generer forsendelseslabels og håndter returneringer
- Kunder — Administrer kundeprofiler og kundefelter
- Lager — Opdater lagerbeholdning, inkl. pr. variant og pr. lokation
- Batches — Opret og administrer batches med udløbsdatoer
- Nyhedsbrev — Administrer abonnenter, lister og kampagner
- Indhold — Blog, sider, menuer, redirects og landingssider
- Brands og leverandører — Administrer brands, producenter og leverandører
- Forsendelse og betaling — Hent forsendelsesmetoder og betalingsgateways
- Webhooks — Modtag notifikationer når ordrer, produkter eller lager ændres
Webhooks
Med webhooks kan du modtage automatiske notifikationer når der sker ændringer i din webshop. Du opretter webhooks via API'et og angiver en URL som Shoporama kalder når en hændelse indtræffer. Understøttede hændelser:
- order — Når en ordre oprettes eller ændrer status
- stock — Når lagerbeholdningen ændres
- product — Når et produkt oprettes eller opdateres
Dokumentation
Den fulde API-dokumentation med alle endpoints, parametre og eksempler finder du i Swagger-dokumentationen under Indstillinger → API → Dokumentation i administrationen. Her kan du også teste kald direkte i browseren.
Forbrugsoversigt
Under hver API-nøgle kan du se en log over alle kald med tidspunkt, endpoint og HTTP-metode. Du kan også eksportere loggen som CSV-fil.
Tip
Har du brug for hjælp til API-integration, er du velkommen til at kontakte os på support@shoporama.dk.