Skip to main content

Getting Started

The widget can be used in two ways:

  • Embedded in an iframe — place it inside any page of your application.
  • As a full page — link directly to the widget URL.

Requirements

To use the widget you need two things:

ParameterSourceDescription
keyProvided by MozrestIdentifies your custom widget
Venue identifierYour systemOne of: mzId (Mozrest ID), rpId (your Reservation Portal ID), or rmsId (your RMS ID)

Widget URL

Base URL: https://widget.mozrest.com

Build the URL by appending query parameters:

https://widget.mozrest.com/?key=YOUR_KEY&mzId=YOUR_VENUE_ID

Query Parameters

ParameterRequiredDefaultDescription
mzId / rmsId / rpIdYesUnique venue identifier
keyYesYour widget key
localeNoBrowser localeWidget language (ISO 639-1)
showHeaderNotrueShow/hide the venue name and address header
bgColorNof4f4f4Page background colour (hex without #)
bgBoxColorNoffffffContainer box colour (hex without #)

Embedding via iframe

<iframe
src="https://widget.mozrest.com/?key=YOUR_KEY&mzId=YOUR_VENUE_ID"
width="100%"
height="650"
frameborder="0"
></iframe>

Full Page

Link directly to the widget URL. The widget will fill the entire browser window:

https://widget.mozrest.com/?key=YOUR_KEY&mzId=YOUR_VENUE_ID