Begrænsning
Der kan foretages et begrænset antal forespørgsler pr. API service pr. IP-adresse. Det konkrete antal varierer mellem API'er og services.
En overskridelse vil resultere i 429 Too Many Requests.
API'er og kryptering
Visse endpoints på Bolius REST API er åbne for forespørgsler både med http og https, mens andre kun har adgang med https.
Som hovedregel er API'er, som leverer redaktionelt indhold, åbne for http såvel som https. Dette muliggør at indhold kan hentes asynkront fra en hjemmeside på et andet domæne, selvom denne hjemmeside ikke hentes via https.
API'er som leverer brugerspecifikt indhold, er til gengæld begrænset til https, og en forespørgsel til en sådan vil resultere i 403 Forbidden.
Betingelser for brug
Bla bla bla
Bolius REST API
Autentificering
Metoder
Svarkoder
Kode | Betydning |
---|---|
200 | OK |
400 | Bad request |
401 | Unauthorized |
403 | Forbidden |
404 | Not found |
405 | Method not allowed |
429 | Too many requests |
500 | Internal server error. |
Adresse
Forespørgsel
Forespørgsel
Svar
Formatering af svar
Eksempel på svar fra Bolius API ver. 1 :
{
"request": {
"timestamp": 1487921662,
"path": "husets-kalender/v1/products",
"parameters": {
"limit": "10"
},
"api": "husets-kalender",
"apiVersionMajor": "v1",
"requestId": "58afe1ff",
"requestTime": 1.7037000656128
},
"response": {
"data":
......
}
}
Beskrivelse af attributterne i "request"-delen af svaret.
Attribut | Beskrivelse |
---|---|
timestamp | Unix timestamp for forespørgslen. |
path | Forespørgslens sti. Det er den del af adressen, som kommer efter den første "/". |
parameters | Objekt som indeholder alle parametre fra forespørgslen. De kan komme både fra GET og POST. |
api | |
apiVersionMajor | |
requestId | |
requestTime | Tiden som forespørgslen har brugt. I sekunder. |