resmio API Documentation



Introduction

Please note that you are accepting the terms of service of the resmio API by using the resmio API.


resmio's API currently supports JSON (JavaScript Object Notation). Content-Type should be "application/json".

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.

Base URL

https://api.resmio.com/v1

Limit and offset


All API list requests support limit and offset parameters.


limit: limits the number of results returned.

offset: offset from first result (zero indexed)


Example:


https://api.resmio.com/v1/facility?limit=20&offset=10

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.


We support the standard authorization code grant type (code): https://tools.ietf.org/html/rfc6749#section-4.1


Available scopes:

  • read

  • write

Token URL: http://api.resmio.com/oauth2/token/

Authorisation URL: http://api.resmio.com/oauth2/authorize/


API Requests

A growing number of basic API requests are also available for Postman (https://www.getpostman.com) here: https://www.getpostman.com/collections/ee2b1c564c9d32bb778d


Create a facility


Resource

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

Description

create a new facility (restaurant)

Required parameters

name

Optional parameters

          'type',

            'street',

           'city',

           'zip_code',

           'country',

           'phone',

           'email',

           'short_description',

           'description',

           'timezone',

           'language',

           'opening_hours',

           'automatically_confirm_bookings',

           'min_book_in_advance_hours',

           'max_num',

           'min_num',

           'max_discount',

           'receipt_extra_text',

           'send_reminders',

           'location',

           'website',

           'facebook_page',

           'restaurantkritik_page',

           'booking_interval',

           'booking_timespan',

           'categories',

           'feedback_enabled',

           'resources_enabled',

           'combined_resources_enabled',


Description

Create a facility. Must be authenticated to perform this operation.

Example POST request

POST request to https://api.resmio.com/v1/facility

Content-Type: application/json

Api-Key:72fbb306846ca003b3231a1eda68d7bd0b8e54ff

Request payload:

{
  "email": "hello@resmio.com",
  "notification_recipients": [
    {
      "contact_info": "hello@resmio.com",
      "contact_info_type": "email"
    }
  ],
  "country": "DE",
  "timezone": "Europe\/Berlin",
  "language": "de",
  "booking_interval": 30,
  "booking_timespan": 60,
  "name": "My test restaurant",
  "description": "This is a description",
  "website": "www.example.com",
  "street": "My street",
  "city": "My city",
  "zip_code": "1234",
  "phone": "12341234",
  "capacity": null,
  "type": "restaurant",
  "opening_hours": [
    {
      "begins": "14:00",
      "ends": "22:00",
      "weekdays": [
        0,
        1,
        2,
        3,
        4,
        5
      ],
      "capacity": 10
    }
  ]
}


List of facilities

Resource

GET https://api.resmio.com/v1/facility

Description

Get a list of facilities (restaurants)

URL Parameter Key (optional)

?offset=

Value

20

URL Parameter Key (optional)

&limit=

Value

50 (set to 0 to show all facilities)

Description

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".

 Example cURL GET request (without any API key)
curl -X GET  "https://api.resmio.com/v1/facility/the-fish/" 
 { "buttonCode": "<script data-resmio-button=\"the-fish\">...<\/script>", "categories": [ "italian", "mediterranean", "pizza" ], "city": "Berlin", "combined_resources_enabled": true, "country": "DE", "description": "This is a restaurant", "description_multilingual": { "en": "Our small restaurant in the Hanover Fair Street is known for the delicious food and the friendly service. We use local produce and offer every day a special lunch menu. We are looking forward to your visit. Reserve but quickly here and we prepare everything before. " }, "email": "hello+the-fish@resmio.com", "facebook_page": "www.facebook.com", "feedback_average": 84, "feedback_change": 0, "feedback_enabled": false, "feedback_public": true, "feedback_this_month": false, "google_page": "www.google.com", "id": "the-fish", "images": [ { "description": "", "facility": "\/v1\/facility\/the-fish", "id": 1510, "image": "https:\/\/resmio-static-files.s3.amazonaws.com\/uploads%2Fthe-fish%2Fimages%2FDead-fish-via-Shutterstock.jpg", "primary": true, "resource_uri": "\/v1\/facility\/the-fish\/images\/1510" } ], "in_partner_network": false, "language": "en", "location": [ 13.40288, 52.49075 ], "max_num": 200, "min_num": 1, "name": "The Fish", "offers": [ "breakfast", "happy-hour" ], "opening_hours": [ { "begins": "12:00", "capacity": 20, "ends": "21:00", "weekdays": [ 0, 1, 2, 3, 4, 5, 6 ] } ], "phone": "", "resource_uri": "\/v1\/facility\/the-fish", "resources_enabled": false, "restaurantkritik_page": "", "short_description": "", "slug": "the-fish", "sms_sent_current_month": 13, "street": "Gneisenaustr. 66", "timezone": "Europe\/Berlin", "type": "restaurant", "verified": false, "website": "http:\/\/thefish.resmio.com\/", "widgetCode": "<div id=\"resmio-the-fish\"><\/div>\n<script>...<\/script>", "zip_code": "10961" }


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.

Availabilities for facility

Resource

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

Description

Get availabilities for a facilitiy

  URL Parameter Key (optional)
 ?date__gte=
 Value
 2013-01-06T15:26:15+00:00 (YYYY-MM-DD HH:MM[:ss[.uuuuuu]][TZ])
 Example cURL GET request to obtain Availabilities for a certain date
 curl -X GET "https://api.resmio.com/v1/facility/the-fish/availability/?date__gte=2016-10-01"
 {
  "meta": {
    "limit": 1000,
    "next": null,
    "offset": 0,
    "previous": null,
    "total_count": 19
  },
  "objects": [
    {
      "available": 20,
      "available_authenticated": 20,
      "checksum": "dc2a259823521f1f99ad4d2e4ce03f7b",
      "date": "2016-10-01T10:00:00Z",
      "id": null,
      "local_date_formatted": "01. Oktober 2016 12:00",
      "local_time_formatted": "12:00",
      "message": null,
      "price_change": 0,
      "resource_uri": "\/v1\/facility\/the-fish\/availability\/1475316000"
    },
    ...
    {
      "available": 20,
      "available_authenticated": 20,
      "checksum": "7a8c27e077e05512b900057e0b52baec",
      "date": "2016-10-01T19:00:00Z",
      "id": null,
      "local_date_formatted": "01. Oktober 2016 21:00",
      "local_time_formatted": "21:00",
      "message": null,
      "price_change": 0,
      "resource_uri": "\/v1\/facility\/the-fish\/availability\/1475348400"
    }
  ]
}

Resources for facility

Resource

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

Description

Get resources (e.g. tables) for a facilitiy

Resources for a certain resource group


Resource

GET https://api.resmio.com/v1/facility/the-fish/resources?resource_groups=1 or

GET https://api.resmio.com/v1/facility/the-fish/resources?resource_groups__in=1,2

Description

Get resources (e.g. tables) for a certain resource group (e.g. room)

Add new resource to a facility

Resource

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

Example

Add a new table to a restaurant

Parameter (required)

name

Value – String

“Table 1”

Parameter (optional)

description

Value – String

“Table at the window”

Parameter (required)

capacity

Value – Integer

4

Parameter (optional)

table_shape

Value – Choices (String)

“round”, “square”, “rectangular”, “oval”

Parameter (optional)

table_size

Value – Choices (String)

“small”, “medium”, “large”

Parameter (optional)

table_location_horizontal

Value – Integer

default: 1

Parameter (optional)

table_location_vertical

Value – Integer

default: 1

Resource Groups for facility


Resource

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

Description

Get resource groups (e.g. dining rooms) for a facilitiy

Create a Resource Group for a facility


Resource

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

Example

Add a new room to a restaurant

Parameter (required) – String

name

Value

“Terrace”

Parameter (optional) – String

description

Value

“Only open May to September”

Parameter (optional) – Array

resources

Value

[“/v1/facility/the-fish/resources/1”, “/v1/facility/the-fish/resources/2”]

Parameter (optional) – Integer

size_horizontal

Value

default: 6

Parameter (optional) – Integer

size_vertical

Value

default: 6

Create a customer


Resource

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

Parameter (optional)

name

Value – String (max length: 512 chars)

“Max Mustermann”

Parameter (optional)

email

Value – String (max length: 254 chars)

mustermann@muster.com

Parameter (optional)

phone

Value – String (max length: 128 chars)

0123456789

Parameter (optional)

street

Value – String (max length: 512 chars)

“Muster Str. 23”

Parameter (optional)

city

Value – String (max length: 512 chars)

“Berlin”

Parameter (optional)

zip_code

Value – String (max length: 32 chars)

“10961”

Parameter (optional)

notes

Value – String

“Customer is vegetarian”

Parameter (optional)

birthday

Value – DateString

“1972-11-10”

Parameter (optional)

newsletter_subscribe

Value – Boolean

default: false

Parameter (optional)

email_verified

Value – Boolean

default: false

 Parameter optional
tags
 Value - List of customer tag URIs
[“/v1/facility/the-fish/customer_tags/1”, “/v1/facility/the-fish/customer_tags/2”]

List of customers for a facility

 Resource
 GET https://api.resmio.com/v1/facility/the-fish/customer
 URL Parameter Key (required)
 Api-Key
 Value
 72fbb306846ca003b3231a1eda68d7bd0b8e54ff (Api-Key for the facility)
 URL Parameter Key (optional)
 ?offset=
 Value
 20
 URL Parameter Key (optional)
 ?limit=
 Value
 50
  URL Parameter Key (optional)
 ?updated__gt=
 Value
 2013-01-06T15:26:15+00:00 (YYYY-MM-DD HH:MM[:ss[.uuuuuu]][TZ])
 Description
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)
 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.

Example HTTP Header Field:
    Accept-Language: da, en-gb;q=0.8, en;q=0.7

Resource

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

Parameter (required)

name

Value

Mustermann (string; max length: 1024 chars)

Parameter (required)

email

Value

mustermann@muster.com (string; max length: 256 chars)

Parameter (required)

phone

Value

0123456789 (string; max length: 128 chars)

Parameter (required)

date

Value

(from availability)

Parameter (required)

num

Value

3 (int)

Parameter (required)

checksum

Value

(from availability)

Parameter (required)

price_change

Value

(from availability)

Parameter (optional)

newsletter_subscribe

Value

true (boolean)

Parameter (required for resmio partners)

source

Value

www.examplepartnerpage.com (string; max length: 255 chars)

Parameter (optional)

comment

Value

table at the window (string; max length: 1024 chars)

Parameter (optional)

booking_timespan_override

Value – Choices (Integer)

30, 45, 60, 90, 120, 180, 240, 300

Parameter (optional)

facility_resources

Value

[“/v1/facility/the-fish/resources/1”, “/v1/facility/the-fish/resources/2”]

Description

Used to post a new booking for a facility to resmio.

-

num - Number of persons


newsletter_subscribe – opt in to the receive emails with offers from the facility (default is false)


{resmio_ newsletter_subscribe – opt in to the receive emails with offers from the resmio GmbH (default is false) - DO NOT IMPLEMENT ANYMORE}


source –The host name of the website from where the booking is made should be included. The source is used to track the number of bookings from each partner.


comment – Here the guest can add a comment to the booking

Parameter (optional)
tags
 Value - List of booking tag URIs
[“/v1/facility/the-fish/booking_tags/1”, “/v1/facility/the-fish/booking_tags/2”]
 Example cURL POST request to create a new Reservation (no authorisation needed)
 curl -X POST -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{ "name": "resmio", "date": "2016-10-01T10:00:00.000Z", "checksum": "dc2a259823521f1f99ad4d2e4ce03f7b", "price_change": 0, "num": 2, "source": "", "email": "hello@resmio.com", "phone": "000", "facility": "/v1/facility/the-fish", "facility_resources": [] } ' "https://api.resmio.com/v1/facility/the-fish/bookings"
 {
  "booking_request_parameters": {
    
  },
  "booking_timespan": 15,
  "checksum": "dc2a259823521f1f99ad4d2e4ce03f7b",
  "comment": "",
  "created": "2016-09-28T14:53:23Z",
  "customer": "\/v1\/facility\/the-fish\/customer\/12026",
  "customer_bookings": 0,
  "customer_cancellations": 0,
  "customer_noshows": 0,
  "customer_notes": "",
  "date": "2016-10-01T10:00:00Z",
  "email": "jann@resmio.com",
  "email_confirmation_status": null,
  "email_verified": false,
  "facility": "\/v1\/facility\/the-fish",
  "facility_resources": [
    
  ],
  "fb_access_token": "",
  "id": 950046,
  "name": "resmio",
  "newsletter_subscribe": false,
  "notes": "",
  "num": 2,
  "phone": "000",
  "price_change": 0,
  "ref_num": "6t6",
  "resource_uri": "\/v1\/facility\/the-fish\/bookings\/950046",
  "source": "",
  "status": "confirmed",
  "tags": [
    
  ],
  "updated": "2016-09-28T14:53:23Z",
  "walk_in": false
}

List of booking information for a facility

 Resource
 GET https://api.resmio.com/v1/facility/the-fish/bookings
 URL Parameter Key (required)
 Api-Key
 Value
 72fbb306846ca003b3231a1eda68d7bd0b8e54ff (Api-Key for the facility)
 URL Parameter Key (optional)
 ?offset=
 Value
 20
 URL Parameter Key (optional)
 ?limit=
 Value
 50
  URL Parameter Key (optional)
 ?updated__gt=
 Value
 2013-01-06T15:26:15+00:00 (YYYY-MM-DD HH:MM[:ss[.uuuuuu]][TZ])
 Description
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.
 Parameter (optional)
limit
 Value – num
20
 Parameter (optional)
offset 
 Value – num
 20

resmio widget and resmio button for integration in websites

resmio widget

Example of the resmio widget code:

<div id="resmio-the-fish"></div>

<script>(function(d, s) {

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

js = d.createElement(s);

js.src = "//static.resmio.com/static/de/widget.js#id=the-fish&width=275px&height=400px";

rjs.parentNode.insertBefore(js, rjs);

}(document, "script"));

</script>

The widget code of each facility can be request with the GET request for a single facility.


Preview of the resmio widget:


 resmio widget for resource groups
 With a parameter the widget can be set up to only show availabilities for a resource group. All bookings will then be placed in that resource group.

<div id="resmio-the-fish"></div>
<script>(function(d, s) {
        var js, rjs = d.getElementsByTagName(s)[0];
        js = d.createElement(s);
        js.src = "//static.resmio.com/static/de/widget.js#id=the-fish&resourceGroup=<resource_group_id>&width=275px&height=400px";
        rjs.parentNode.insertBefore(js, rjs);
}(document, "script"));
</script>

The resourceGroup ID can be sourced through the resourceGroup endpoint.



resmio button

Example of the widget code:

<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>

The widget code of each facility can be request with the GET request for a single facility.

On desktop the resmio button will open the widget in a lightbox. On mobile the button will link to the widget directly. The widget is shown as a webpage.


Preview of the resmio button:


 resmio button for resource groups
By specifying the parameter "data-resmio-resourcegroup" (s. example below) you the button will open a widget which only shows the availabilities for this resource group (id 123 in the example below) <script data-resmio-button="the-fish" data-resmio-resourcegroup="123">     (function(d, s) {         var js, rjs = d.getElementsByTagName(s)[0];         js = d.createElement(s);         js.src = "//static.resmio.com/static/en/button.js";         js.async = true;         rjs.parentNode.insertBefore(js, rjs); }(document, "script") ); </script>


Setting language of resmio button

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:

<div id="resmio-the-fish"></div><script>(function(d, s) {

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

js.src = "//static.resmio.com/static/de/widget.js#id=the-fish&width=275px&height=400px";

rjs.parentNode.insertBefore(js, rjs); }(document, 'script'));</script>

The background color of the widget and the text color of the widget can be adjusted with the URL parameter “backgroundColor” and “color” in hex values:

<div id="resmio-the-fish"></div><script>(function(d, s) {

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

js.src = "//static.resmio.com/static/de/widget.js#id=the-fish&width=275px&height=400px&backgroundColor=60493b&color=ffffff";

rjs.parentNode.insertBefore(js, rjs); }(document, 'script'));</script>


The name field in the widget can be prefilled with the URL parameter "name":


<div id="resmio-the-fish"></div><script>(function(d, s) {

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

js.src = "//static.resmio.com/static/de/widget.js#id=the-fish&width=275px&height=400px&name=example";

rjs.parentNode.insertBefore(js, rjs); }(document, 'script'));</script>


The phone field in the widget can be prefilled with the URL parameter "phone":


<div id="resmio-the-fish"></div><script>(function(d, s) {

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

js.src = "//static.resmio.com/static/de/widget.js#id=the-fish&width=275px&height=400px&phone=041315804988";

rjs.parentNode.insertBefore(js, rjs); }(document, 'script'));</script>


The e-mail field in the widget can be prefilled with the URL parameter "email":


<div id="resmio-the-fish"></div><script>(function(d, s) {

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

js.src = "//static.resmio.com/static/de/widget.js#id=the-fish&width=275px&height=400px&email=test@example.com";

rjs.parentNode.insertBefore(js, rjs); }(document, 'script'));</script>


The comment field in the widget can be prefilled with the URL parameter "comment":


<div id="resmio-the-fish"></div><script>(function(d, s) {

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

js.src = "//static.resmio.com/static/de/widget.js#id=the-fish&width=275px&height=400px&comment=Birthday";

rjs.parentNode.insertBefore(js, rjs); }(document, 'script'));</script>


The comment field in the widget can be hidden with the URL parameter "commentsDisabled":


<div id="resmio-the-fish"></div><script>(function(d, s) {

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

js.src = "//static.resmio.com/static/de/widget.js#id=the-fish&width=275px&height=400px&commentsDisabled=1";

rjs.parentNode.insertBefore(js, rjs); }(document, 'script'));</script>


The offer opt-in field in the widget can be unchecked with the URL parameter "newsletterSubscribe":


<div id="resmio-the-fish"></div><script>(function(d, s) {

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

js.src = "//static.resmio.com/static/de/widget.js#id=the-fish&width=275px&height=400px&newsletterSubscribe=false";

rjs.parentNode.insertBefore(js, rjs); }(document, 'script'));</script>

Styling resmio button

The resmio button can be styled with the following CSS:

<style type="text/css">

.resmio-button .btn {

 background-color: #002547;

 background-image: linear-gradient(top,#04539c,#011a32);

 background-image: -webkit-linear-gradient(top,#04539c,#011a32);

 background-image: -o-linear-gradient(top,#04539c,#011a32);

 background-image: -moz-linear-gradient(top,#04539c,#011a32);

 background-image: -ms-linear-gradient(top,#04539c,#011a32);

 border-style: 1px solid #633613;

 border-color: #002547;

}

.resmio-button .btn:hover, .resmio-button .btn:focus {

  background-color: #011a32;

  background-image: linear-gradient(top,#c09e82,#8c6a50);

  background-image: -webkit-linear-gradient(top,#c09e82,#8c6a50);

  background-image: -o-linear-gradient(top,#c09e82,#8c6a50);

  background-image: -moz-linear-gradient(top,#c09e82,#8c6a50);

  background-image: -ms-linear-gradient(top,#c09e82,#8c6a50);

  border-style: 1px solid #49260a;

  border-color: #011a32;

}

</style>

Direct link to the reservation widget of a facility

Link structure

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.
 Code
<!-- Begin resmio Signup Form --> <style type="text/css"> #resmio_embed_signup form {display:block; position:relative; text-align:left; padding:10px 0 10px 3%;} #resmio_embed_signup h2 {font-weight:bold; padding:0; margin:15px 0; font-size:1.4em;} #resmio_embed_signup input {border:1px solid #999; -webkit-appearance:none;} #resmio_embed_signup input:focus {border-color:#333;} #resmio_embed_signup .button {clear:both; background-color: #aaa; border: 0 none; border-radius:4px; color: #FFFFFF; cursor: pointer; display: inline-block; font-size:15px; font-weight: bold; height: 32px; line-height: 32px; margin: 0 5px 10px 0; padding: 0 22px; text-align: center; text-decoration: none; vertical-align: top; white-space: nowrap; width: auto;} #resmio_embed_signup .button:hover {background-color:#777;} #resmio_embed_signup .resmio-field-group {clear:left; position:relative; width:96%; padding-bottom:3%; min-height:50px;} #resmio_embed_signup .resmio-field-group label {display:block; margin-bottom:3px;} #resmio_embed_signup .resmio-field-group input {display:block; width:100%; padding:8px 0; text-indent:2%;} #resmio_embed_signup .resmio-field-group select {display:inline-block; width:99%; padding:5px 0; margin-bottom:2px;} #resmio_embed_signup .resmio-field-group.input-group ul {margin:0; padding:5px 0; list-style:none;} #resmio_embed_signup .resmio-field-group.input-group ul li {display:block; padding:3px 0; margin:0;} #resmio_embed_signup .resmio-field-group.input-group label {display:inline;} #resmio_embed_signup .resmio-field-group.input-group input {display:inline; width:auto; border:none;} #resmio-embedded-subscribe {clear:both; width:auto; display:block; margin:1em 0 1em 5%;} </style> <style type="text/css"> /* Add your own resmio form style overrides in your site stylesheet or in this style block. We recommend moving this block to the HEAD of your HTML file. */ </style> <div id="resmio_embed_signup"> <form action="//app.resmio.com/the-fish/subscribe" method="post" target="_blank"> <h2>Signup for our newsletter</h2> <div class="resmio-field-group"> <label for="resmio-NAME">Your name </label> <input type="text" value="" name="name" class="required" id="resmio-NAME"> </div> <div class="resmio-field-group"> <label for="resmio-EMAIL">Email Address </label> <input type="email" value="" name="email" class="required email" id="resmio-EMAIL"> </div> <div> <input type="submit" value="Subscribe" name="subscribe" id="resmio-embedded-subscribe" class="button"> </div> </form> </div> </textarea> </form>

resmio reputation widget

 Setup of reputation management widget

resmio reputation widget allows you to show a graphic like this:

Documentation can be found here: https://resmio.github.io/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
 16.11.14 Added facility resources, resource groups and customer endpoints, updated booking resource.
 26.06.15 Information about creating a facility
 02.07.15 Information about setting language of button has been added.
 07.07.15 Preview of widget and button added
 06.01.16 Added OAuth2 Authorisation and profile endpoint
 05.04.16 Added disable comment field option to widget styling
 20.04.16 List of customers for a facility added and updated__ for list of bookings added
 01.09.16 Added newsletter signup form and preview of reputation widget
 28.09.16 Providing example cURL requests and a link to a collection of Postman requests
Added an explanation of booking status choices.
 04.11.16 Information about language setting for transactional e-mails as unauthenticated user was added.
 22.11.16 Changed facility type from required parameter to optional when creating a facility
 24.11.16 Changed name and email to optional when creating a customer
 19.01.17 Added create user endpoint
 20.01.17 Added information on how to prefill inputs in the widget
 09.03.17
 When creating a user the username is not needed anymore
 16.03.17 With user creation parameters can be named utm or cmp
 20.03.17 iframe example
 02.06.17 button for resource groups example