Zum Inhalt springen

Docs

Wie die API funktioniert, in Kürze. Jeder Endpunkt, jedes Feld und jeder Fehlercode steht in der API-Referenz.

API-Referenz öffnen

Zwei Schnittstellen

  • Die Rentman-Schnittstelle prüft das Token, testet die Verbindung, blättert durch den Katalog, reicht Bilder durch und leitet Mietanfragen weiter. Sie ist im Test und in jedem bezahlten Tarif offen.
  • Die Lizenz- und Update-Schnittstelle bietet Releases, einmalige signierte Downloads und Installationsberichte für die Produkte eines bezahlten Tarifs. Sie braucht ein an eine Domain gebundenes Token.

Basis-URL

Jeder Pfad ist relativ zu dieser URL. Aufrufe nutzen HTTPS und JSON, mit einem Request-Body von höchstens 64 KiB.

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

Tokens und Labels

Senden Sie das Token als Authorization: Bearer von Ihrem Server. Jedes Konto hat ein Standard-Token; weitere Tokens tragen ein eigenes Label. Ein Wert wird einmal angezeigt, und beim Neugenerieren bleiben ID, Label und Domain erhalten.

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

Limits und Retry-After

Jedes Token macht 60 Aufrufe pro Minute, und eine Seite enthält 1 bis 100 Einträge. Ein Limit antwortet mit 429 und Retry-After in Sekunden: Warten Sie so lange, und wiederholen Sie dann.

Problem-Dokumente

Jeder Fehler ist ein Problem-Dokument nach RFC 9457. Ihr Code liest den stabilen englischen code; title und detail folgen Accept-Language. Nennen Sie die request_id, wenn Sie dem Support schreiben.

Seitenweise mit Cursor

GET /catalog ohne Cursor startet einen Sync-Lauf. Folgen Sie next_cursor, um bis zu 30 Minuten dieselbe Version zu lesen, und senden Sie das ETag als If-None-Match zurück, um 304 zu erhalten, wenn sich nichts geändert hat.

Idempotenz

POST /rental-requests nutzt order_id als Schlüssel, pro Token. Wiederholen Sie eine unklare Anfrage mit derselben order_id und nie mit einer neuen: Die Wiederholung gibt die erste Antwort wieder, statt eine zweite Anfrage anzulegen.

Buchungsmodi

Jedes Token hat einen Buchungsmodus. off, der Standard, beantwortet Mietanfragen mit 403 booking_disabled; request leitet sie an Rentman weiter. Nur der Kontoinhaber ändert den Modus, im Dashboard.

Desktop- und Mobil-Apps

Ein Token in einer verteilten Desktop- oder Mobil-App lässt sich auslesen. Das ist nur für interne Werkzeuge vertretbar; setzen Sie sonst ein eigenes Backend zwischen App und xRentman.

Changelog

Jede Änderung der API ist maschinenlesbar unter GET /wp-json/xrentman/v1/changelog abrufbar, ohne Token.

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