RoomFollow · Mobile API v1

Mobil uç kataloğu.

iOS için mevcut 66 yöntem/yol eşleşmesi. Temel adres: https://app.roomfollow.com/api/mobile/v1.

19 Eylül 2026 · Katalog, route dosyalarıyla otomatik testte karşılaştırılır; yeni veya kaldırılan uçta test güncelleme gerektirir.

Bildirimler

GET
/notifications

Bearer oturumuna ait son 100 bildirim, okunmamış sayısı, tercihler ve push durumu. İçerik güncel otel yetkileriyle filtrelenir. kind: reservation, morning, daily, weekly, hourly, kbs (KBS misafir/personel bildirimi gecikmesi veya bağlantı sorunu; sorun sürdükçe 15 dk’da bir yinelenir, çözülünce “KBS sorunu çözüldü”; kişisel veri içermez) veya night_audit (geciken gün sonu; yalnız night_audit.run).

PUT
/notifications/settings

Bu cihaz oturumunun bildirim türlerini ve otelin yerel saatine göre özet saatlerini kaydeder.

POST
/notifications/device

APNs token ve sandbox/production ortamını kayıt eder; token sunucuda şifrelenir.

POST
/notifications/read

id veya all:true ile yalnız bu oturumdaki bildirimleri okundu işaretler.

Otel operasyonu

GET
/cashier

Salt okunur resepsiyon kasası; day=YYYY-MM-DD. cashier.read gerekir; detaylar webdeki resepsiyon/müdür rol kapsamına bağlıdır.

GET
/blocks

frontdesk.read; iş gününden sonraki 90 gün için oda atamaları ve blokajlar.

GET
/dashboard

Dashboard göstergeleri; finansal alanlar rol yetkisine bağlıdır.

GET
/overview

Operasyon özeti.

GET
/rooms

Oda planı ve durumlar.

GET
/rooms/{roomId}/notes

frontdesk.read; tesise ait odanın en son 100 notu.

POST
/rooms/{roomId}/notes

frontdesk.read + reservation.update; body alanıyla 1–1000 karakter oda notu.

GET
/guests

frontdesk.read; tesise bağlı kayıtlı misafirler, 100 kayıtlık sayfalar; offset ve nextOffset ile devam edilir.

GET
/frontdesk

Ön büro hareketleri.

GET
/frontdesk/{stayId}/check-in

Check-in ön bilgileri.

POST
/frontdesk/{stayId}/check-in

Check-in işlemini gerçekleştirir.

GET
/frontdesk/{stayId}/check-out

Check-out ön kontrolleri.

POST
/frontdesk/{stayId}/check-out

Check-out işlemini gerçekleştirir.

Oturum

GET
/health

Herkese açık servis sağlık bilgisi; otel verisi içermez.

POST
/auth/login

Tesis kodu, e-posta, parola ve cihaz bilgisiyle giriş. Yalnız otel hesapları; Garsonup hesapları genel hata alır. Yönetici bir sonraki girişte şifre değişikliği istediyse kullanıcı web panelinde yeni şifre belirleyene kadar giriş açıklayıcı mesajla reddedilir.

POST
/auth/verify

Etkinse ikinci adım doğrulama kodunu tamamlar.

POST
/auth/refresh

Geçerli refresh token ile oturumu yeniler; token döndürülür ve eskisi geçersizleşir.

POST
/auth/logout

Bearer oturumunu iptal eder.

Hesap ve ekip

GET
/account

Oturumdaki kullanıcı ve tesis hesabı.

GET
/account/photo

Bearer oturumuna ait kullanıcının profil fotoğrafı; binary image, no-store; fotoğraf yoksa 404.

POST
/account/password

Parola değiştirme. Yeni parola en az 6 karakterdir; yalnız rakam da olabilir (en fazla 72 bayt, başta/sonda boşluk yok). Başarılı değişim bekleyen zorunlu değişikliği ve açık sıfırlama bağlantısını kapatır.

GET
/team

Yetki kapsamındaki tesis ekibi.

POST
/team

Yetkili kullanıcı tarafından ekip üyesi oluşturma.

POST
/team/{membershipId}

Ekip üyeliği ve yetki işlemleri.

Rezervasyon

GET
/reservations

query, status, start/end (YYYY-MM-DD; konaklama çakışması) ve offset ile rezervasyon listesi; sayfa 100 kayıt, nextOffset null ise son sayfa.

POST
/reservations

Yeni rezervasyon oluşturma.

GET
/reservations/options

Tesisin oda tipi, fiyat ve form seçenekleri.

GET
/reservations/{reservationId}

Rezervasyon ayrıntıları.

POST
/reservations/{reservationId}

operation ile düzenleme, oda atama, iptal veya no-show işlemi. NO_SHOW yalnız geliş tarihi tesis iş gününe ulaşmış rezervasyonda yapılır; aksi hâlde 409 reservation_action_failed. Fiyat planında iptal / no-show cezası tanımlıysa NO_SHOW ve ücretsiz iptal süresi geçmiş CANCEL işlemi oda folyosuna ceza satırı yazar (yanıt gövdesi değişmez).

POST
/identity-scan

Yetkili personel için multipart kimlik/pasaport okuma. Yanıt okunan alanlar, confidence ve uncertainFields içerir; uncertainFields'teki alanları kullanıcıya belgeyle karşılaştırtın.

Kat hizmetleri

GET
/housekeeping

Temizlik görevleri ve oda durumları.

POST
/housekeeping/{roomId}

Temizlik başlatma, bitirme, kontrol ve yetkili görevli atama (ASSIGN, assignedToId, notes).

POST
/housekeeping/{roomId}/dnd

Rahatsız etmeyin durumu.

GET
/maintenance

Bakım ve arıza kayıtları.

POST
/maintenance

Bakım kaydı oluşturma.

POST
/maintenance/{requestId}

Bakım kaydının durumunu güncelleme.

Raporlar ve gün sonu

GET
/forecast

year, month ve includeOptions ile aylık forecast; günlük adults, children ve people dahil; report.read gerekir.

GET
/reports

Yetkiye göre rapor kataloğu ve geçmişi. catalog=reference yalnızca gerçek veriyle çalışan katalog raporlarını ve parametre alanlarını (form) döndürür; giriş kayıtları audit.read ister.

POST
/reports

catalogCode ile web rapor hesaplamaları; start/end, currency, detaylı gelir seçenekleri ve katalog formundaki ek alanlar (ör. nationality, groupBy, windowDays). Hücreler Türkçe görüntü etiketidir. Hazırlanan raporlar 400 report_not_ready döner. En çok 10.000 satır; truncated kısmi sonuçları belirtir. Eski çağrılar 60 satırlık önizlemeyi korur.

GET
/night-audit

Manuel gün sonu ön kontrolü.

POST
/night-audit

expectedBusinessDate ile yetkili manuel kapanış.

Kimlik bildirimi (KBS)

GET
/kbs-bridge/pending

RoomFollow Windows programı Polis KBS köprüsü: bekleyen giriş/çıkış/oda değişikliği bildirimleri. dryRun=1 kayıt kiralamaz; kimlik numarası yalnız bu yanıtta çözülür. canOperateKbs gerekir.

GET
/kbs-bridge/inhouse

Portal karşılaştırması için içerideki misafirler (kimlik numarasının yalnız son 2 hanesi).

POST
/kbs-bridge/results

Portal sonuçları; kayıt yalnız SENT ile kurum kabul etti olur. Tekrar gelen sonuç duplicate döner, deneme modu 422.

POST
/kbs-bridge/reconcile

Tur özeti (KBS / İçeride / Hatalı) ve portal karşılaştırması; eksikler kuyruğa alınır.

Folyo

GET
/folios

Yetkili folyo listesi.

GET
/folios/options

Folyo işlem seçenekleri.

GET
/folios/{folioId}

Folyo ayrıntısı.

POST
/folios/{folioId}/charges

Yetkili folyo harcama kaydı.

POST
/folios/{folioId}/payments

Yetkili folyo tahsilatı.

Restoran

GET
/pos

Restoran, masa, menü ve adisyon verileri. Adisyon ödemelerinin kind alanı web POS'ta odaya (ROOM_CHARGE) veya cariye (CITY_LEDGER) yazılan ödemeler için bu değerleri alabilir; iptal satırı negatif tutarlıdır.

POST
/pos/checks

Adisyon oluşturma.

POST
/pos/checks/{checkId}/lines

Adisyon kalemleri.

POST
/pos/checks/{checkId}/kitchen

Mutfağa gönderme.

POST
/pos/checks/{checkId}/settlements

Yetkili adisyon tahsilatı (yalnız CASH ve CREDIT_CARD; sözleşme değişmedi). Odaya / cariye yazma mobil API'de yoktur.

SPA

GET
/spa

Hizmet, kaynak ve randevu verileri. Ödeme kind değeri CASH / CREDIT_CARD dışında web panelinden yazılan ROOM_CHARGE / CITY_LEDGER ve eşit negatif *_REVERSAL olabilir.

POST
/spa/appointments

Randevu oluşturma.

POST
/spa/appointments/{appointmentId}/status

Randevu durumu.

POST
/spa/appointments/{appointmentId}/payments

Yetkili SPA tahsilatı.

Entegrasyon operasyonu

GET
/channels

rate.read: yalnız etkin CHANNEL_HUB şirket eşlemesi doğrulanmış kanal seçenekleri ve komut geçmişi; Partner API veya otel kanal kurulum kataloğu değildir.

POST
/channels

rate.update: queueNow:false ile hedefsiz yerel taslak; queueNow:true ayrıca integration.operate ve doğrulanmış etkin hedef gerektirir.

POST
/channels/{commandId}

Yetkili kanal komutu işlemi.