Ga naar inhoud

Docs

Hoe de API werkt, in het kort. Elk endpoint, veld en elke foutcode staat in de API-referentie.

API-referentie openen

Twee interfaces

  • De Rentman-interface controleert het token, test de verbinding, bladert door de catalogus, geeft afbeeldingen door en stuurt huuraanvragen door. Ze is open in de proefperiode en in elk betaald abonnement.
  • De licentie- en update-interface biedt releases, eenmalige ondertekende downloads en installatierapporten voor de producten van een betaald abonnement. Ze vereist een token dat aan een domein is gekoppeld.

Basis-URL

Elk pad is relatief aan deze URL. Aanroepen gebruiken HTTPS en JSON, met een request body van hoogstens 64 KiB.

https://xrentman.com/wp-json/xrentman/v1/

Tokens en labels

Stuur het token als Authorization: Bearer vanaf je server. Elk account heeft een standaardtoken; extra tokens krijgen een eigen label. Een waarde wordt één keer getoond, en bij opnieuw genereren blijven id, label en domein behouden.

curl --fail-with-body --proto '=https' \
  -H "Authorization: Bearer $XRENTMAN_TOKEN" \
  -H 'Accept: application/json' \
  'https://xrentman.com/wp-json/xrentman/v1/me'

Limieten en Retry-After

Elk token doet 60 aanroepen per minuut, en een pagina bevat 1 tot 100 items. Een limiet antwoordt met 429 en Retry-After in seconden: wacht zo lang en herhaal dan.

Probleemdocumenten

Elke fout is een probleemdocument volgens RFC 9457. Je code leest de vaste Engelse code; title en detail volgen Accept-Language. Vermeld de request_id als je support mailt.

Paginering met cursor

GET /catalog zonder cursor start een synchronisatieronde. Volg next_cursor om tot 30 minuten dezelfde versie te lezen, en stuur de ETag terug als If-None-Match om 304 te krijgen als er niets veranderd is.

Idempotentie

POST /rental-requests gebruikt order_id als sleutel, per token. Herhaal een onduidelijke aanvraag met dezelfde order_id en nooit met een nieuwe: de herhaling geeft het eerste antwoord terug in plaats van een tweede aanvraag aan te maken.

Boekingsmodi

Elk token heeft een boekingsmodus. off, de standaard, beantwoordt huuraanvragen met 403 booking_disabled; request stuurt ze door naar Rentman. Alleen de accounteigenaar wijzigt de modus, in het dashboard.

Desktop- en mobiele apps

Een token in een verspreide desktop- of mobiele app kan worden uitgelezen. Dat is alleen aanvaardbaar voor interne tools; zet anders een eigen backend tussen de app en xRentman.

Changelog

Elke wijziging van de API staat machineleesbaar op GET /wp-json/xrentman/v1/changelog, zonder token.

curl --fail-with-body --proto '=https' \
  -H 'Accept: application/json' \
  'https://xrentman.com/wp-json/xrentman/v1/changelog'