Open API integration for custom websites & apps

Set Up Open API Integration with Your Restaurant Website / App


I. Purpose

This feature allows restaurants to integrate botX POS with their own website or mobile application using Open API.
It enables external systems to access menu data and create orders based on configured permissions.


II. Setup Instructions

1. Set Up Open API Integration

  1. In the management portal, go to Integrations.

  2. Click Details on Open API.

  3. Click Add.

  4. Enter the application name you want to connect.

  5. Click Save to add the application.


2. Configure Menu & Access Permissions

Initial setup

Later updates


a. Add Items

  1. Go to Menu → Items.

  2. Click Add.

  3. Select:

    • The top checkbox to select all items, or

    • Individual items you want to expose to the application.


b. Add Categories


c. Add Modifiers

Modifier options:

Click Save to apply the changes.


3. Configure Open API Permissions

a. General Settings

  1. Go to the Settings tab.

  2. Select General Settings.

  3. Click Edit and configure access permissions as needed.

  4. Save your changes.


b. Business Hours

  1. Go to Business Hours.

  2. Click Edit.

  3. Set operating hours for the integrated application.

    • Use Quick Settings if the hours are the same for all days.

  4. Click Save.


c. Order Settings

  1. Go to Order Settings.

  2. Click Edit.

  3. Configure the following options:

Set average time for food preparation

Automatically confirm orders

Automatically send the order to the kitchen

  1. Click Save to apply the settings.


✔ After setup is complete, your restaurant’s website or app can securely interact with botX POS through Open API, using the menu, permissions, and order workflow you configured.

Published with Nuclino