SmartPOS Mobile App | SmartAPI Host Setup
      Back to home
      1. INTERNAL - Bepoz Help Guides
      2. Installation / System Setup Guides
      3. SmartPOS Mobile App | SmartAPI Host Setup

      SmartAPI Host

      Overview

      Starting the SmartAPI Host from the Bepoz Programs folder is the fourth step required to setup and start using SmartPOS Mobile.

      It is required because instances of SmartPOS Mobile Till configured in BackOffice can be registered to a SmartPOS Mobile application. 

      Prerequisites

      • Minimum Bepoz version of 4.7.3.x 

      • Minimum .NET version of 4.8

      • Completion of SmartPOS Mobile App Setup in the given order:

        1. SmartPOS Mobile Workstation Setup

        2. SmartPOS Mobile Venue Maintenance Setup 

        3. SmartPOS Mobile Till Function Map Setup Guide

      About

      SmartAPI Host is a new program that can be found within the Bepoz program directory. It's main function is to initialise all API tills that are configured for each venue, or a sub-group of API tills depending on configuration. The user can enable SmartAPI Host to autostart - similar to SmartController - via the configuration options within Database.exe

      It's secondary function is to provide monitoring capabilities along with the ability to refresh & restart each individual API Till 

      N.B - When implementing SmartPOS Mobile in a Multi Venue environment, each venue will run their own version of SmartAPI Host to monitor the SmartPOS Mobile devices configured for that venue

      SmartAPI Host Autostart

      • SmartAPI Host can be configured to auto start via database.exe 

      SmartAPI Host Usage

      • SmartAPI Host is a Bepoz monitoring application, which helps the operator to understand the status of each individual SmartPOS mobile app

      • To start SmartPOS Mobile manually, the operator must go to C:\\BEpoz\\Programs directory and search for "smartapihost.exe" and run the application

        • NB: SmartController must be running before Starting SmartAPI Host or it will show the following error "Could Not Connect, Waiting for SmartController Startup" 

      • Once the SC is running, the SmartAPI Host will display all of the instances of SmartAPI's configured within BackOffice

      • The Menu Bar has 3 options: File, API & Refresh

        • File: It has the option to Exit the application

        • API: It has the options to:

          • Start API: This allows the Operator to Start a highlighted SmartAPI i.e. SmartPOS Mobile Till

          • Stop API: This allows the Operator to Stop a highlighted SmartAPI i.e. SmartPOS Mobile Till

          • Restart API: This allows the Operator to Restart a highlighted SmartAPI i.e. SmartPOS Mobile Till

          • Close All: This allows the Operator to Close All SmartAPIs available within the SmartAPI Host

        • Refresh: Refreshes all of the SmartPOS Mobile APIs configured within BackOffice, it adds or removes APIs as they are updated within BackOffice. For e.g.: - In the image below, another API has been added within BackOffice and hence, 2 SmartAPIs are available within SmartAPI Host

      SmartPOS Mobile App Setup Articles

      To complete the full & correct setup of the SmartPOS Mobile App, the operator must follow & execute these articles provided

      1. SmartPOS Mobile Workstation Setup

      2. SmartPOS Mobile Venue Maintenance Setup

      3. SmartPOS Mobile Till Function Map Setup Guide

      4. SmartAPI Host

      5. SmartPOS Mobile App Configuration Screen

      6. SmartPOS Mobile App Usage