Each facility (restaurant) has an unique resmio ID in the system. For this documentation the resmio test facility The Fish (http://thefish.resmio.com) with the ID “the-fish“ is used. The resmio ID will not be changed when the name of the facility is edited by the user.

For any questions relating to the resmio API contact us via email at support@resmio.com.

Authenticated requests

Some operations can only be performed by authenticated users. We provide API keys and OAuth 2 as methods of authentication.

API Key

Each user has a resmio API-Key. The API-Key is needed for access to data that is only available to the restaurant administrator. The API-Key can be requested from support@resmio.com. The API-Key for the test facility The Fish is: 72fbb306846ca003b3231a1eda68d7bd0b8e54ff

Authenticated requests must send an HTTP header “Api-Key”.

OAuth 2

An application has to be registered by contacting support@resmio.com. Please also specify the required callback URL(s) in your message.

A registered OAuth application is assigned a unique Client ID and Client Secret. The Client Secret should not be shared.

Add parameter offset to skip a number of facilities. Add parameter limit to show more or less then the default of 20 facilities. If the limit is set to 0 all facilities will be shown. The first parameter should be separated by ? and all the following by & (see for more details: http://en.wikipedia.org/wiki/Query_string).

List of facilites for partner integration

Resource

GET https://api.resmio.com/v1/facility?in_partner_network=true

Description

Get a list of facilities for partner networks (restaurants)

In_Partner_network restaurants have been reviewed by resmio for their authenticity and should be integrated by partners. Add parameters as described in List of facilities to effect the number of shown facilities.

Facilities by location

Resource

GET https://api.resmio.com/v1/facility?near=longitude,latitude

URL Parameter Key (optional)

&distance=

Value

20000 (for 20km in this case)

Description

Get a list of facilities ordered by location. By default facilites in a radius of 50 km will be shown. This value can be adjusted by adding the „radius“ URL parameter and a kilometer (km) value.

Single facility

Resource

GET https://api.resmio.com/v1/facility/the-fish

Description

Get one facility. As part of the response you will get the button and widget code for integration in to a website. The field name of the button code is “buttonCode”. The field name of the widget code is "widgetCode".

Create user

The response of the POST request contains the API-key for the created user. This should be saved on the clients side in order to make authenticated requests for that user (e.g. create a new facility). An e-mail for password creation will be sent to the e-mail of the new user after user creation.

Resource

POST https://api.resmio.com/v1/users

Description

Create a new user

Example

Creation of a user example@resmio.com

Parameter (required)

email

Value - String

"example@resmio.com"

Parameter (optional)

first_name

Value - String

"Michael"

Parameter (optional)

last_name

Value - String

"Example"

Parameter (required)

utm_source or cmp_source

Value - String

"affiliatename"

Parameter (required)

utm_medium or cmp_medium

Value - String

"affiliate"

Parameter (optional)

utm_name or cmp_name

Value - String

"product_plan_2017q1_testing"

Parameter (optional)

utm_term or cmp_term

Value - String

"test"

Parameter (optional)

utm_content or cmp_content

Value - String

"bannercontent"

Facilities of the logged-in user

Resource

GET https://api.resmio.com/v1/users/me

Description

Get data about the currently logged in user and the associated facilities.

WARNING: The facilities array currently provides additional data. Please only rely on the “resource_uri” and "id" fields. The additional fields are pending removal.

Get a list of the customers for a facility. Add parameter offset to skip a number of customers. Add parameter limit to show more or less then the default of 20 customers. Add parameter updated_gt to only show customers which have been update since the specified date and time (gte, lt and lte is supported).

The API-Key for each facility is currently not exposed to the user. The API-Key for a facility can be requested from support@resmio.com. The preferred authentication methode for 3rd parties is OAuth.

Create a customer tag

Resource

POST https://api.resmio.com/v1/facility/the-fish/customer_tags

Parameter (required)

Name

Value

The Tag name, some string

Get all customer tags for a facility

Resource

GET https://api.resmio.com/v1/facility/the-fish/customer_tags

Description

Returns a list of all customer tags for a facility

Create a booking tag

Resource

POST https://api.resmio.com/v1/facility/the-fish/booking_tags

Parameter (required)

Name

Value

The Tag name, some string

Get all booking tags for a facility

Resource

GET https://api.resmio.com/v1/facility/the-fish/booking_tags

Description

Returns a list of all booking tags for a facility

Create a new booking (as an authenticated user)

Resource

POST https://api.resmio.com/v1/facility/the-fish/bookings

Description

When being authenticated, you have less required fields when creating a new booking and can also specify more fields

Parameter (required)

date

Value – String

"2016-10-01T10:00:00.000Z"

Parameter (required)

source

Value – String (will be displayed in the web interface)

"example.com" or "My-Mobile-App"

Parameter (required)

num

Value – Integer (number of persons)

2

Parameter (optional)

name

Value – String

"John Doe"

Parameter (optional)

email

Value – String

"john@example.com"

Parameter (optional)

phone

Value – String

"0800222333444"

Parameter (optional)

comment

Value – String

"A table by the window please!"

Parameter (optional)

status

Value – String

Choices are:
- "arrived": Guest has arrived but is not yet seated (resource / capacity is being blocked)
- "cancelled": Guest or User has cancelled the booking (resource / capacity is freed)
- "confirmed": Booking is confirmed (resource / capacity is being blocked)
- "finished": Guest has left (resource / capacity is freed)
- "noshow": Guest did not show up (resource / capacity is freed)
- "seated": Guest is currently seated (resource / capacity is being blocked)
- "unconfirmed": Booking was not yet confirmed by the user (resource / capacity is being blocked)

Create a booking for a facility (unauthenticated)

Transactional emails will be sent in the language you specify using the Accept-Language HTTP header.

If none of the specified languages are available, the default language, set in the restaurant settings, will be used.

Get a list of the bookings for a facility. Add parameter offset to skip a number of bookings. Add parameter limit to show more or less then the default of 20 bookings. Add parameter updated_gt to only show bookings which have been update since the specified date and time (gte, lt and lte is supported).

The API-Key for each facility is currently not exposed to the user. The API-Key for a facility can be requested from support@resmio.com. The preferred authentication methode for 3rd parties is OAuth.

List of public feedbacks & guest comments for a facility

Resource

GET https://api.resmio.com/v1/facility/the-fish/feedback

Description

Get a list of feedbacks and public comments for a facility with a total count of all available feedbacks. This is only available when enabled by the facility. Add parameter offset to skip a number of feedbacks. Add parameter limit to show more or less then the default number of feedbacks.

The language of the resmio button text “Book a table” can be changed in the button code by loading the language specific button javascript file. For this the language shortcode in the url has to be set.

<script data-resmio-button="the-fish">

(function(d, s) {

var js, rjs = d.getElementsByTagName(s)[0];

js = d.createElement(s);

js.src = "//static.resmio.com/static/de/button.js";

js.async = true;

rjs.parentNode.insertBefore(js, rjs); }(document, "script")

);

</script>

Currently the supported languages are:

English - en

Danish - da

German - de

Styling & manipulation of the resmio widget and resmio button

Styling resmio widget

The width and height of the resmio widget can be adjusted with the URL parameters “width” and “height” in pixel:

Direct link to the reservation widget of a facility

The widget can be opened as a webpage with the following link structure:

http://app.resmio.com/*facilityid*/widget?source=*partner-id*

Example for the The Fish:

http://app.resmio.com/the-fish/widget?source=www.examplepartner.com

iframe for reservation widget

example iframe code

The reservation widget can be loaded in an iframe. The facility id and source need to be adjusted:
<iframe src="https://app.resmio.com/the-fish/widget?source=www.restaurant.de" width="275" height="400"> </iframe>
resmio does not recommend to implement the reservation widget thru an iframe.

Code embed for newsletter signup form

Instructions

Please update the facility id in the POST URL to the desired facility. For localization please change the h2 title, the labels and the submit value.

resmio reputation widget

Version of this documentation

25.07.13

First version

25.09.13

Added „List of verified facilities for partner integration“; added „List of booking information for a facility“; expansion of the introduction to include information about the API-Key; added radius parameter to the facilities by location call; expansion of the documentation of the booking POST (needs cleanup); deleted all links to hurl.it (don’t want to rely on 3rd parties for the documentation)

14.11.13

Missing information about pagination added to facilities list

19.02.14

Delete resmio_newsletter_subscribe as it should not be supported anymore. Styling for widget and button added.

27.02.14

Added new resmio logo

06.03.14

Added “resmio widget and resmio button for integration in websites” and “Direct link to the reservation widget of a facility”

12.05.14

Added some integral parts for styling the reservation button

16.10.14

Changed list of facilities for partner integration to use the in_partner_network field; removed a blank space in styling of the resmio widget and resmio button