programming

Developers

StayNTouch Connect APIs

StayNTouch Connect APIs are open APIs that enable the connectivity of a great variety of apps – from Point of Sale to Revenue Management Systems or Door Locking Solutions. Any vendors of systems and devices that match the functionality of StayNTouch Cloud PMS are welcome to develop interfaces to the StayNTouch data. Typically, we try to return as much data as possible in our GET /Reservations calls so that there is no need for multiple calls to be made.

We also provide several webhooks to allow you to pull only the data you need versus constant poling to gather data. And, it’s all free – we do not charge any setup fees.

AVAILABLE APIs

Here you can find our current available APIs. We are continuously working on adding new APIs so please feel free to check the above link for any future additions.

WEBHOOKS

Guidelines

Webhooks allows you to receive real-time HTTP notifications of changes to specific objects in the StayNTouch Connect APIs. For example, we could send you a notification when any of your reservations change their date range for your Hotel Chain.

Objects, Fields and Values

There are many types of events in we offer, such as Reservation or Group events, so whenever you configure a Webhook you must first choose an event type. Whenever there’s a change to the value of any object field you have subscribed to, we will send you a notification. Notifications are sent to as HTTP POST requests and contain a JSON payload that describes the change.

As an example, a Webhook that is set up and subscribed to a ‘create_reservation’ event. If a new reservation is made, we would send a notification that would look like this:

{
 "created_at": "2018-10-15T19:11:40.622Z",
 "event": "create_reservation",
 "id": 2739,
 "data": {
    "arrival_date": "2018-10-15",
    "arrival_time": null,
    "confirmation_number": "108732",
    "departure_date": "2018-10-16",
    "departure_time": null,
    "hotel_id": 777,
    "id": 3157941,
    "object": "reservation",
    "status": "reserved"
 },
 "object": "event"
}

Schema

Name	Description	Type	Required
`created_at`	The time the event was created. This is in UTC Format is 'YYYY-MM-DDTHH:MM:SS' e.g.: 2018-05-10T13:50:30	datetime	Yes
`data`	Object containing data associated with the event. *Please reference each data schema: Reservation, ReservationNotification,Inventory, Group.	object:{Data Schema}	Yes
`event`	Event name you subscribe. e.g.: create_reservation, checkin, update_inventory	string	Yes
`id`	Event identifier. The unique number for the transaction.	integer	Yes
`object`	Object name. Always 'event'.	string	Yes

List of Available Webhooks

Object	Description	Events
Account	An event for Company or Travel Agent	create_account edit_account
EndOfDay	An event for End of Day changes and notifications	complete_end_of_day
Group	An event for Group	create_group edit_group
Guest	An event for Guest	create_guest edit_guest anonymize_guest
Inventory	An event for Inventory changes (hotel and room type)	update_inventory
Reservation	An event for Reservation changes and notifications	create_reservation edit_reservation cancel_reservation checkin_available checkin_completed checkin_failed checkout_available checkedout pre_checkin_available pre_checkin_success pre_checkin_failure room_assignment_succeed room_move
ReservationRevenue	An event for Reservation Revenue changes and notifications	reservation_revenue_update
RoomStatus	An event for Housekeeping Room status changes	room_status
RoomStatusService	An event for the Room service status like an out of order or out of service in the calendar view	room_status_service

WHERE TO START?

Our APIs are open and available for everyone to surf, but to retrieve any data, you will require API credentials. To get started please complete this short form and we will be in touch in no time