API settings

How to enable and configure API access

To use the API service, access the restaurant panel and configure the settings from the Tools > API Access menu.

Settings

Enable API access

Enables the account to send orders to the management system and receive commands from it.

Restaurant UID

Unique identifier for the restaurant account.

API Key

This is the key to add as HTTP Header X-Api-Key to requests made from the management system to xMenu. Alternatively, for access to advanced functions such as Menu Import and Order Insertion, use X-Client-Id and X-Client-Secret provided by our staff.

Event notification URL

This is the address that xMenu must call to pass information to the management system when an event occurs (e.g.: new order, order confirmed, order expired…).

Times in UTC format

If selected, the date-time information in notifications is in UTC timezone. If not selected, dates are converted to the local timezone.

Close orders after synchronization/confirmation

If selected, after synchronization (if confirm option is not enabled) or after confirmation via the management system, orders do not remain on the INCOMING ORDERS page but are automatically closed and archived in history.