What is the open API?
The Stays Open API is an interface that allows the integration of functionalities with other platforms. By that, developers can create customized solutions for their own system.
How to activate Stays API?
Access [App Center > Stays API > External API], select [Active] and click the save button. You will see your access credentials after activation.
How does the API billing work?
The charge is $19 per month. This amount will be automatically included in your invoice and charged monthly while the API is activated on your system. It can be deactivated at any time.
Does Stays have a partnership with any developer for the API?
We don't have any partnerships. You can hire a developer on your own and send our complete documentation to check all the information.
What can I do with the API?
Check out some examples of using the endpoints available in our API.
It checks the possibility of reservation and returns the link for the guest to complete the reservation. The guest will be created within the Stays system if they don't exist.
- It is usually used for external apps to create reservations through the website. In this case, the reservation data gets at Stays with the name of the partner (external app) that generated the reservation.
It allows creating, managing, and reading promo codes from the system.
- Often used for marketing campaigns. As an example, if you integrate it with guest endpoints, you can automate coupon creation processes for birthdays.
It allows searching for available listings, calculating the price of a specific listing, managing reservations and clients.
- It is often used to manage reservations externally, such as in apps or external web pages. With the API, it's possible to create an app that allows third parties (guests or collaborators) to manage reservations, whether they are existing or new reservations (reservation creation endpoint).
It allows managing bank accounts for payments on the website and reading records present in the owners' statement.
- Often used to integrate reservation information into external apps. Important: there's no interbank link, that means that bank transactions don't happen through Stays. The integration works the same way as our system, only for recording and validating payments.
- It's also possible to use it to integrate the balance data of each owner and, with that, create customized solutions.
Get information about availability, prices, and restrictions for a specific period. Allows updating prices and restrictions.
- It can be used to mirror the general calendar screen in an external management system, such as PriceLabs.
It allows managing pricing rules by season.
- It works similarly to the listing calendar module. The calendar is used for the night pricing model, while the pricing is for the period pricing model.
- Often used for external management of seasons and events.
It returns, manages, and creates information related to the content of properties and listings created on the system. It can be used to manage descriptive content, rooms, and groups.
- It's often used to manage content externally and also to create pages or external apps that need to be filled out with the system's content, such as a guest app.
It only includes the functionality of custom fields in the system. There are four endpoints to read, create, edit, and delete the system's custom fields.
- It can be used for various operations. The most common is to use the custom field to communicate information about the listing to the guest, such as the Wi-Fi password or socket voltage, for example.
Used to customize the system experience. By that, you can manage custom fields that will be included externally on websites and apps, for example.
- If you need a custom field not included on the system, you can use this endpoint to include fields in a registration form for an external application or website, for example.
Used for reading price, availability, and house rules settings. It's also possible to use it to change the parameters of house rules.
- Generally used to generate external search filters and also to generate information about listings on an external page.
Used for the system to trigger notifications when something is changed.
- Clients often use it for reservation creation logic. When a reservation is created on the system, we can send a webhook so that this reservation is also created on an external calendar.
- It's possible to create various change automations with the webhooks we have in the documentation.