REST interface
Complete API documentation for integration with Shoporama
Bemærk
Dokumentationen er flyttet til den nye Swagger UI. Denne side er ikke længere vedligeholdt og kan indeholde forældet information.
Endpoints
Om REST interfacet
Vores REST-interface er udviklet med det udgangspunkt, at det skal være muligt for vores kunder selv at udvikle integrationer med lager- og regnskabssystemer. Det er derfor kun metoder der støtter omkring det vi understøtter.
Vi benytter os af HTTP-protokollen over SSL/TLS, og al data sendes og modtages i JSON-format.
Authorization fungerer på shop-niveau, og hver shop har mulighed for at oprette de tokens de ønsker. Hver token tillader som udgangspunkt 1.000 daglige kald. Denne grænse kan godt sættes op, hvis I kontakter os og forklarer hvorfor. For at angive token skal der angives en Authorization-header som nedenstående:
Authorization: Shoporama ade0fe8617b0825996baa9c8a9324ddb
Bemærk at metoden i ovenstående skal være Shoporama.
Paginering
I kald der indeholder lister - fx produkter eller ordrer, er der et maks. antal resultater vi returnerer. Derfor
vil resultatet indeholde et paging element der viser hvilken del af datasættet man kigger på:
{
"paging": {
"offset": 30,
"limit": 10,
"count": 10,
"total": 1000
},
"products": [
[...]
]
}
For at vælge hvilken del af datasættet man vil se på kan man angive argumenterne limit=100 og offset=30 i
den URL man kalder.
Eksempel på API kald
Et komplet eksempel på hvordan man trækker produkter der er blevet ændret siden 1. januar 2020:
Request:
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 integrationResponse:
HTTP/1.1 200 OK
Content-Type: application/json
{
"paging": {
"offset": 30,
"limit": 10,
"count": 10,
"total": 1000
},
"products": [
[...]
]
}