How to use resOS REST API

We provide API-credentials in order to broaden the spectrum of what can be done with resOS’ restaurant management system. When you use resOS REST API, you can allow your existing systems to communicate directly with your booking system. The API can give you access to all relevant information from resOS. This includes guest-data, booking-data, or any other data that you might be interested in integrating into another system.

Generate keys directly in the system

In order to use our REST API, you need a private API key that will identify and authorize the request. In order to manage your API keys and generate new ones, you go to Menu–> Settings–>API credentials . You then click on “Generate new key”, and done!

The API keys give you access to all your data and your customers’ contact information, so be sure to keep them safe and only use them on the server-side code, and not shown to the user. Find out more about the guidelines by reading our API documentation.

With resOS’ API, you can

  • Integrate into an e-mail system such as MailChimp, Campaign Monitor, etc.
  • Allow for the interaction between resOS and an accounting system such as Microsoft Dynamics, Debitoor, E-conomic, etc.
  • Integrate into a CRM or business intelligence platform.

Please let us know at [email protected] if you have questions or if something you need is missing. We are extending the API as needed and per your request.