REST-grensesnitt

Komplett API-dokumentasjon for integrasjon med Shoporama

Vennligst merk

Dokumentasjonen har blitt flyttet til det nye Swagger-grensesnittet. Denne siden vedlikeholdes ikke lenger og kan inneholde utdatert informasjon.

Sluttpunkter

Om REST-grensesnittet

REST-grensesnittet vårt er utviklet for at kundene våre selv skal kunne utvikle integrasjoner med lager- og regnskapssystemer. Det er derfor kun metoder som støtter det vi støtter.

Vi bruker HTTP-protokollen over SSL/TLS, og alle data sendes og mottas i JSON-format.

Autorisasjonen fungerer på butikknivå, og hver butikk har mulighettil å opprettede tokenenede ønsker. Som standard tillater hvert token 1000 daglige anrop. Denne grensen kan økes hvis du kontakter oss og forklarer hvorfor. For å angi tokenet må et autorisasjonshode som det nedenfor angis:

Authorization: Shoporama ade0fe8617b0825996baa9c8a9324ddb

Merk at metoden i det ovenstående må være Shoporama.

Paginering

I anrop som inneholder lister - f.eks. produkter eller bestillinger - er det et maksimalt antall resultater vi returnerer. Derfor vil resultatet inneholde et personsøkerelement som viser hvilken del av datasettet du ser på:

{
  "paging": {
    "offset": 30,
    "limit": 10,
    "count": 10,
    "total": 1000
  },
  "products": [
    [...]
  ]
}

For å velge hvilken del av datasettet du vil se på, kan du angi argumentene limit=100 og offset=30 i URL-en du kaller.

Eksempel på et API-kall

Et komplett eksempel på hvordan du trekker produkter som har endret seg siden 1. januar 2020:

Forespørsel:

GET /REST/product?last_modified=2020-01-01T00:00:00&limit=100 HTTP/1.1
Host: www.shoporama.dk
Accept: */*
Authorization: Shoporama ade0fe8617b0825996baa9c8a9324ddb
User-Agent: Min Shoporama integration

Svar:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "paging": {
    "offset": 30,
    "limit": 10,
    "count": 10,
    "total": 1000
  },
  "products": [
    [...]
  ]
}

Nødsituasjon