The LobbyCentral API is JSON based web service that allows third-party applications to integrate with the LobbyCentral database.


Possible actions are creating and retrieving check-in requests, retrieving service descriptions, users, and customers.


To use the API, your application will need a API Token, which can be can created through the On-Premise Portal.  A Private Key is also needed for the API service.


The API service is installed as a separate web application and connects directly to the LobbyCentral database.  It is not necessary to install the application onto the LobbyCentral server.


System Requirements

  • LobbyCentral 6.3.0 or higher
  • Windows 2012 or higher, 32 or 64-bit
  • Minimum 4GB memory


 Obtaining a Private Key and API Token

  1. Log into download.lobbycentral.com
  2. In the left menu, click Generate API Key
  3. Click Generate Key and Token
  4. Copy and paste the key/token pair into a file and save in a safe location.


Caution!  You cannot retrieve your key/token pair.  If you lose this information, you must create a new key/token.  It is recommended that you save this information before proceeding.


Installation


Be sure you have your key and token before installing!

  1. Log into download.lobbycentral.com
  2. On the Download page, locate the API Service package
  3. Save the download and copy to the server for installation
  4. Start the installer by double-clicking LobbyCentralAPI.msi
  5. Select the default installation folder or select a different location
  6. Copy and paste the Private key generated by the portal
  7. Enter the LobbyCentral server name.  Do not use HTTP or include .com or servicecenterweb.  For example, if users go to http://ourlocalserver/servicecenterweb, your server name is OURLOCALSERVER.  This name must match the one that users access.
  8. Enter the LobbyCentral database connection information.   If you do not have this information, it can be obtained by opening c:\program files(x86)\fuhr software\lobbycentral\web\CustomerSettings.config on the LobbyCentral server.
  9. Click Finish to start the installation


Restriction of Use


The LobbyCentral API license allows you to use the API for internal or Intranet applications only.  It may not be used outside of your local network.


To use with an application that exists out of network (OON), you must develop a broker application that can communicate between the OON application and the LobbyCentral API.   Support of OON applications and broker apps is not provided by Fuhr Software.


By using the API, you assume all risk and responsibility of its usage and will take appropriate security measures to ensure LobbyCentral data is not compromised.