Algemeen

Geschreven:

Url's

De Rompslomp API is RESTful. De url van de meeste resources is als volgt opgebouwd:

https://rompslomp.nl/api/v1/{company_id}/{resource_type}[/{id}]

Lees hierover meer op de Requests & responses pagina. Bij API endpoints vind je het complete overzicht van alle resource-typen, acties en opties. Authenticeren doe je met een toegangstoken, lees daarover meer bij API tokens en OAuth.

Dataformaat

Uitgaande data (response bodies) is opgemaakt volgens het JSON data formaat. Ook ingaande data (request bodies) moet als JSON zijn opgemaakt.

Meer informatie vind je op de Requests & responses pagina. In de documentatie van de individuele API endpoints worden gestructureerde beschrijvingen en voorbeelden van de verschillende JSON objecten gegeven.

Paginering

Opgevraagde lijsten van objecten worden altijd gepagineerd. De volgende request parameters zijn daarvoor beschikbaar:

Parameter Omschrijving Waarde
page De opgevraagde pagina Getal vanaf 1
Standaard 1
per_page Aantal objecten per pagina Getal tussen 1 en 100
Standaard 40

Gepagineerde responses bevatten de volgende headers:

Header Omschrijving
X-Page De opgevraagde pagina, bijvoorbeeld '1'
X-Per-Page Aantal objecten per pagina, bijvoorbeeld '40'
X-Total Totaal aantal objecten op alle pagina's, bijvoorbeeld '123'

Triggers

Write-only resource-attributen die niet worden opgeslagen maar in plaats daarvan een ander effect hebben, noemen we 'triggers'. Je kan triggers herkennen aan de underscore in de naam. Een voorbeeld van een trigger is _publish voor facturen.

Request-begrenzing

Het aantal requests dat je per tijdseenheid kan maken is begrensd. Wanneer de grens wordt overschreden wordt een error response teruggegeven met statuscode 429. De Retry-After response header geeft aan na hoeveel seconden de begrenzing vervalt. Maak dan geen extra requests binnen die tijd.

Header Omschrijving
Retry-After Aantal seconden waarbinnen geen requests moeten volgen