İçeriğe geç

Docs

API’nin nasıl çalıştığı, kısaca. Her uç nokta, alan ve hata kodu API başvuru kaynağında yer alır.

API başvuru kaynağını açın

İki arayüz

  • Rentman arayüzü tokeni denetler, bağlantıyı test eder, kataloğu sayfa sayfa okur, görselleri aktarır ve kiralama taleplerini iletir. Denemede ve her ücretli pakette açıktır.
  • Lisans ve güncelleme arayüzü, ücretli bir paketin ürünleri için sürümler, tek kullanımlık imzalı indirmeler ve kurulum raporları sunar. Bir alan adına bağlı token gerektirir.

Temel URL

Her yol bu URL’ye görelidir. Çağrılar HTTPS ve JSON kullanır; istek gövdesi en fazla 64 KiB olur.

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

Tokenler ve etiketler

Tokeni sunucunuzdan Authorization: Bearer olarak gönderin. Her hesabın varsayılan bir tokeni vardır; ek tokenlerin kendi etiketi olur. Bir değer yalnızca bir kez gösterilir ve yeniden oluşturulduğunda kimliği, etiketi ve alan adı korunur.

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

Sınırlar ve Retry-After

Her token dakikada 60 çağrı yapar ve bir sayfa 1 ile 100 arasında öğe içerir. Bir sınır, saniye cinsinden Retry-After ile 429 yanıtı verir: o kadar bekleyin, sonra tekrarlayın.

Problem belgeleri

Her hata, RFC 9457’ye uygun bir problem belgesidir. Kodunuz sabit İngilizce code alanını okur; title ve detail, Accept-Language başlığına uyar. Desteğe yazarken request_id değerini belirtin.

İmleçle sayfalama

İmleçsiz GET /catalog bir senkronizasyon turu başlatır. Aynı sürümü en fazla 30 dakika okumak için next_cursor değerini izleyin; hiçbir şey değişmediğinde 304 almak için ETag değerini If-None-Match olarak geri gönderin.

İdempotans

POST /rental-requests, token başına order_id değerini anahtar olarak kullanır. Belirsiz bir talebi aynı order_id ile tekrarlayın, asla yenisiyle değil: tekrar, ikinci bir talep oluşturmak yerine ilk yanıtı döndürür.

Rezervasyon modları

Her tokenin bir rezervasyon modu vardır. Varsayılan off, kiralama taleplerine 403 booking_disabled ile yanıt verir; request onları Rentman’e iletir. Modu yalnızca hesap sahibi panelden değiştirir.

Masaüstü ve mobil uygulamalar

Dağıtılan bir masaüstü veya mobil uygulamadaki token çıkarılabilir. Bu yalnızca iç araçlar için kabul edilebilir; aksi halde uygulama ile xRentman arasına kendi arka ucunuzu koyun.

Değişiklik günlüğü

API’deki her değişiklik, token gerekmeden GET /wp-json/xrentman/v1/changelog adresinden makine tarafından okunabilir.

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