Integrační formát
Formát Superhostem ICS
Použijte tento iCalendar profil, když externí systém potřebuje importovat rezervace přímo do Superhostem. Je přísnější než běžné blokovací kalendáře, protože každá událost musí mít stabilní externí ID rezervace a kontaktní údaje hosta.
Tento formát slouží k importu vašich ICS dat rezervací do Superhostem, včetně externích ID, kontaktních údajů hosta, termínů, počtu hostů a volitelné ceny rezervace.
Superhostem ICS je autoritativní zdroj dat. Když se změní událost se stejným externím ID, Superhostem aktualizuje existující rezervaci. Když je událost označená jako smazaná, Superhostem rezervaci stornuje bez hard delete. Externí ID se nesmí nikdy znovu použít.
Kompletní iCalendar příklad
BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//Your System//Superhostem ICS 1.0//EN
X-SUPERHOSTEM-FORMAT:1
BEGIN:VEVENT
UID:booking-123@example.com
X-SUPERHOSTEM-EXTERNAL-ID:booking-123
DTSTART;VALUE=DATE:20260901
DTEND;VALUE=DATE:20260905
SUMMARY:Jane Doe
DESCRIPTION:External ID: booking-123\nPrimary guest name: Jane Doe\nPrimary guest email: jane@example.com\nPrimary guest phone: +420777111222\nGuests: 2\nTotal price: 12500\nCurrency: CZK
END:VEVENT
END:VCALENDARPovinná pole události
- UID
- Platné iCalendar UID.
- X-SUPERHOSTEM-EXTERNAL-ID
- Povinné unikátní ID rezervace. Musí být stabilní mezi synchronizacemi a unikátní v rámci feedu.
- DTSTART;VALUE=DATE
- Datum příjezdu ve formátu YYYYMMDD. Pokud místo VALUE=DATE posíláte DATE-TIME, přidejte buď UTC koncovku Z, nebo TZID, například DTSTART;TZID=Europe/Prague:20260901T150000.
- DTEND;VALUE=DATE
- Datum odjezdu ve formátu YYYYMMDD. Pokud místo VALUE=DATE posíláte DATE-TIME, přidejte buď UTC koncovku Z, nebo TZID, například DTEND;TZID=Europe/Prague:20260905T100000.
- SUMMARY
- Krátký lidsky čitelný název. Superhostem pro data rezervace používá primární jméno hosta z DESCRIPTION.
Pole v DESCRIPTION
- Primary guest name
- Povinné jméno primárního hosta.
- Primary guest email
- Povinný e-mail primárního hosta pro claim a registrační workflow.
- Primary guest phone
- Volitelný telefon primárního hosta.
- Guests
- Volitelné kladné celé číslo.
- Total price
- Volitelná celková cena rezervace jako číslo.
- Currency
- Volitelný ISO kód měny. Pokud je vyplněná Total price, výchozí hodnota je CZK.
- Status: deleted
- Volitelný marker smazání. Ponechte stejné externí ID a nastavte Status: deleted, Status: cancelled, Deleted: true, Cancelled: true nebo Canceled: true. Rezervace se v Superhostem stornuje bez hard delete.
Plain text příklad DESCRIPTION
External ID: booking-123
Primary guest name: Jane Doe
Primary guest email: jane@example.com
Primary guest phone: +420777111222
Guests: 2
Total price: 12500
Currency: CZKKompletní iCalendar příklad
BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//Your System//Superhostem ICS 1.0//EN
X-SUPERHOSTEM-FORMAT:1
BEGIN:VEVENT
UID:booking-123@example.com
X-SUPERHOSTEM-EXTERNAL-ID:booking-123
DTSTART;VALUE=DATE:20260901
DTEND;VALUE=DATE:20260905
SUMMARY:Jane Doe
DESCRIPTION:External ID: booking-123\nPrimary guest name: Jane Doe\nPrimary guest email: jane@example.com\nPrimary guest phone: +420777111222\nGuests: 2\nTotal price: 12500\nCurrency: CZK
END:VEVENT
END:VCALENDARPříklad DESCRIPTION pro smazanou rezervaci
External ID: booking-123
Status: deleted