Installation and Setup
      Back to home
      1. Ariox Help Center
      2. Installation and Setup
      3. Installation and Setup

      How do I install an API for Sage 100?

      Installing the Sage 100 API.

      1. Navigate to https://bitbucket.org/arioxdev/sage100_api/src/DEV/Installer/SFX/API-Installer.exe.
      2. Click on the View raw link to start downloading the installer. The Ariox Bitbucket credentials will be required.

      3.  When the installer runs, click Yes to start the installation.

           

      4.  On the Welcome page of the installation wizard, click Next.

         

      5.  On the Select Installation Folder page, a default installation folder is provided. The folder can be changed if necessary. When the destination folder has been entered, click Next.

         

      6.  On REST API configuration page, the system installer provides pre-populated values. Each of the fields may be modified, and each is explained below the image file.

      Host and Port

      • The Host and Port is the Sage 100 REST API server binding. Replace the * with the desired domain, server name, or IP address. Note the examples in the colored box below.
      • The port number may be changed by replacing the default number 9999 with the desired port.
      • http://*:9999/ - It will serve requests from any origin to port number 9999.
      • http://mycompanydomain:9999/ - It will serve only external requests (from the internet) to port number 9999.
      • http://192.168.1.1:9999/ - It will serve only LAN (by server IP) requests to port number 9999.
      • http://servername:9999/ - It will serve only LAN (by server name) requests to port number 9999.
      • http://localhost:9999/ - It will serve only local requests (from the same server) to port number 9999.

      Sage MAS 90 Installation, home path

      • The Sage MAS 90 installation, home path is the path to the home directory where the Sage 100 instance is installed.  UNC Paths are supported (i.e., \\servername\Home).

      Lumino config file path

      The Lumino config file path is the path to the config directory where the Lumino Remote Operator was installed.

      When all the fields have been verified and/or modified, click the Next button.

      7.  On the Confirm Installation page, click Next to start the installation.  When the installation is complete, Close the install wizard.

      8.  For the first time only, the service must be started manually. Navigate to Windows Services and locate the Sage 100 Rest API service. Start the Sage 100 Rest API service by clicking the Start link in the left navigation, or right clicking and selecting Start.

       

      9.  Verify that the status of the service changes to Running.

      Optional Performance Test

      1.  Use Postman, any other similar software, or any web browser that supports unsafe URLs (HTTP), such as Internet Explorer. Then, perform the following request.

      • Method: GET
      • URL: http://:{Port}/api (URL that fits with the configuration in Step 5)
      • Example URL: http://localhost:9999/api

      If the response code is 200 and the content is empty, then the REST API service is running and working appropriately.

       

      To troubleshoot install problems with Sage 100 API installs click here.