Vai al contenuto

Docs

Come funziona l’API, in breve. Ogni endpoint, campo e codice di errore è nel riferimento API.

Apri il riferimento API

Due interfacce

  • L’interfaccia Rentman verifica il token, testa la connessione, scorre il catalogo, inoltra le immagini e le richieste di noleggio. È aperta nella prova e in ogni piano a pagamento.
  • L’interfaccia licenze e aggiornamenti offre release, download firmati monouso e report di installazione per i prodotti di un piano a pagamento. Richiede un token legato a un dominio.

URL di base

Ogni percorso è relativo a questo URL. Le chiamate usano HTTPS e JSON, con un corpo della richiesta di massimo 64 KiB.

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

Token ed etichette

Invia il token come Authorization: Bearer dal tuo server. Ogni account ha un token predefinito; i token aggiuntivi hanno una propria etichetta. Un valore viene mostrato una sola volta, e rigenerarlo mantiene id, etichetta e dominio.

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

Limiti e Retry-After

Ogni token fa 60 chiamate al minuto, e una pagina contiene da 1 a 100 elementi. Un limite risponde 429 con Retry-After in secondi: attendi quel tempo, poi ripeti.

Documenti di problema

Ogni errore è un documento di problema RFC 9457. Il tuo codice legge il code inglese stabile; title e detail seguono Accept-Language. Indica il request_id quando scrivi al supporto.

Paginazione con cursore

GET /catalog senza cursore avvia un ciclo di sincronizzazione. Segui next_cursor per leggere la stessa versione per un massimo di 30 minuti, e rimanda l’ETag come If-None-Match per ricevere 304 quando non è cambiato nulla.

Idempotenza

POST /rental-requests usa order_id come chiave, per token. Ripeti una richiesta incerta con lo stesso order_id e mai con uno nuovo: la ripetizione restituisce la prima risposta invece di creare una seconda richiesta.

Modalità di prenotazione

Ogni token ha una modalità di prenotazione. off, quella predefinita, risponde alle richieste di noleggio con 403 booking_disabled; request le inoltra a Rentman. Solo il titolare dell’account cambia la modalità, nella dashboard.

App desktop e mobili

Un token dentro un’app desktop o mobile distribuita può essere estratto. È accettabile solo per strumenti interni; altrimenti metti un tuo backend tra l’app e xRentman.

Changelog

Ogni modifica dell’API è leggibile dalle macchine su GET /wp-json/xrentman/v1/changelog, senza token.

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