RoomFollow Connectivity API
Kimlik doğrulama
OAuth 2.0 Client Credentials, tesis kapsamı ve güvenli anahtar saklama kuralları.
Client Credentials akışı
Token isteğiUTF-8
curl -X POST https://app.roomfollow.com/api/v1/oauth/token \
-H "Content-Type: application/x-www-form-urlencoded" \
-u "$ROOMFOLLOW_CLIENT_ID:$ROOMFOLLOW_CLIENT_SECRET" \
-d "grant_type=client_credentials"Başarılı yanıt access_token, token_type, expires_in ve kapsam listesini döndürür. Jetonlar 15 dakika geçerlidir.
Yetki kapsamları
| Kapsam | Paneldeki adı | İzin |
|---|---|---|
| reservations.read | Rezervasyonları okuma | Değişen rezervasyonları imleçli olarak okur (misafir iletişim bilgisi yok). |
| reservations.write | Rezervasyon yazma | Kanal veya satış sisteminden gelen rezervasyon olaylarını kuyruğa alır. |
| inventory.read | Müsaitlik ve fiyatlar | Oda tipi bazında günlük müsaitlik ve fiyat matrisi. |
| property.read | Tesis ve katalog | Oda tipleri, fiyat planları ve oda fotoğrafları. |
| mappings.read | Kanal eşleştirmeleri | Oda ve fiyat planı kodlarının sağlayıcı karşılıkları. |
Folyo ve misafir verisi için ayrı okuma kapsamı yoktur. Tahsilat, giriş ve çıkış bilgisi kişisel veri içermeyen webhook olaylarıyla iletilir.
Self-servis anahtar yönetimi
- İstemciyi tesisin müdürü (API erişimi yetkisi) panelden açar; istemci yalnız o tesisin
propertyCodedeğerine erişir. Başka tesis kodu403 property_forbiddendöner. client_secretyalnız oluşturma ve yenileme anında bir kez gösterilir. RoomFollow anahtarı açık halde saklamaz; yalnız amaç ayrımlı HMAC özeti tutulur.- Anahtarı yenile yeni bir secret üretir; eski secret ve onunla alınmış bütün erişim jetonları hemen geçersiz olur (
401 invalid_token). Kesintisiz geçiş için ikinci bir istemci açıp trafiği taşıyın, ardından eskisini iptal edin. - İptal et geri alınamaz. İptal edilen veya RoomFollow tarafından durdurulan istemci jeton alamaz (
401 invalid_client), mevcut jetonlar401 invalid_tokenalır. - İsteğe bağlı IP izin listesi en fazla 20 IPv4/IPv6 adresi veya CIDR bloğu içerir. Liste doluysa dışarıdan gelen jeton ve API istekleri
403 ip_not_allowedalır. - Panel her istemci için son kullanım zamanını, son 24 saatteki istek sayısını ve dakikalık istek sınırını (self-servis istemcilerde 60) gösterir.