Aller au contenu

Docs

Le fonctionnement de l’API, en bref. Chaque endpoint, champ et code d’erreur figure dans la référence API.

Ouvrir la référence API

Deux interfaces

  • L’interface Rentman vérifie le jeton, teste la connexion, parcourt le catalogue, relaie les images et transmet les demandes de location. Elle est ouverte pendant l’essai et dans chaque formule payante.
  • L’interface de licences et de mises à jour propose des versions, des téléchargements signés à usage unique et des rapports d’installation pour les produits d’une formule payante. Elle exige un jeton lié à un domaine.

URL de base

Chaque chemin est relatif à cette URL. Les appels utilisent HTTPS et JSON, avec un corps de requête de 64 Kio au plus.

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

Jetons et libellés

Envoyez le jeton en Authorization: Bearer depuis votre serveur. Chaque compte a un jeton par défaut ; les jetons supplémentaires portent leur propre libellé. Une valeur n’est affichée qu’une fois, et la régénérer conserve son identifiant, son libellé et son domaine.

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

Limites et Retry-After

Chaque jeton fait 60 appels par minute, et une page contient de 1 à 100 éléments. Une limite répond 429 avec Retry-After en secondes : attendez ce délai, puis réessayez.

Documents de problème

Chaque erreur est un document de problème RFC 9457. Votre code lit le code anglais stable ; title et detail suivent Accept-Language. Indiquez le request_id quand vous écrivez au support.

Pagination par curseur

GET /catalog sans curseur lance un cycle de synchronisation. Suivez next_cursor pour lire la même version pendant 30 minutes au plus, et renvoyez l’ETag en If-None-Match pour obtenir 304 quand rien n’a changé.

Idempotence

POST /rental-requests utilise order_id comme clé, par jeton. Répétez une demande incertaine avec le même order_id et jamais avec un nouveau : la répétition renvoie la première réponse au lieu de créer une seconde demande.

Modes de réservation

Chaque jeton a un mode de réservation. off, par défaut, répond aux demandes de location par 403 booking_disabled ; request les transmet à Rentman. Seul le titulaire du compte change le mode, dans le tableau de bord.

Applications de bureau et mobiles

Un jeton intégré à une application de bureau ou mobile distribuée peut être extrait. Ce n’est acceptable que pour des outils internes ; sinon, placez votre propre backend entre l’application et xRentman.

Changelog

Chaque modification de l’API est lisible par machine sur GET /wp-json/xrentman/v1/changelog, sans jeton.

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