Installing‎ > ‎

Install the Single-User Demonstration Package

Live API Creator can run in a small footprint. The self-contained, single-user version of Live API Creator is a demonstration and development package and is based on Jetty. This package does not require that you install an application server (Jetty is included in the zip file) or a database management system (DBMS) (it uses Apache Derby). This demonstration package includes JDBC drivers for MariaDB and MySQL, Apache Derby/JavaDB, and PostgreSQL. 

Note: The single-user demonstration package is not upgraded automatically. To upgrade to a newer Live API Creator version, you must export your APIs from your current Live API Creator version and then import them into the newer version.

For more information about upgrading Live API Creator to a newer version, see Upgrade Live API Creator to a Newer Version.

This package is designed for evaluations and training:

  • It includes sample applications. You can see a complete API with logic and security using the sample applications
  • You can use the New API wizard to see how to create an API from an existing database (use pre-provided Northwind), or create a new database

Even if your team has Live API Creator installed on a centralized server for team development, we recommend you get it for your computer, to facilitate learning and experimentation.

For more information about getting Live API Creator on your computer, see the CA Live API Creator trial page or download it from CA Support (for existing customers).

The following video explains how to install this package and the Business to Business Example:

Install API Creator

Installing this package involves installing an API Server. When installing an API Server on your own hardware or in your own cloud, we recommend:

  • As many CPUs as required for peak load. API Server takes advantage of all available CPUs.
  • A minimum of 512MB and a maximum of 4GB of heap size for the container. Larger heap sizes are counter-productive. If you have extra RAM, you can use several containers.
  • A few GB of available disk space for log files.

To minimize the round-trip trip time to your databases, install Live API Creator close to the database. Ideally, the ping time between API Server and the database server should be less than one millisecond. You can test the ping time in API Creator (Test database).

Verify the Prerequisites

Ensure you have completed the following before unzipping and running this package:

  • You have Java JDK 1.8.0 or later installed.

For more information about:

Verify your Java version is JDK 8 or higher by starting a command line/terminal, and running:

java -version (checks that Java is installed and available)
javac -version (checks that the JDK is installed)
  • You have at least 100MB of free disk space.

Unzip and Run the Package

Unzip and run the file to a local directory folder. We recommend creating a folder (for example, lac) that will contain your Live API Creator Jetty install and your API projects (such as B2B), as illustrated in the following image:

Start the API Server

    1. From a command window (terminal or cmd), change directories to the location of your installation by issuing the following command (see the install folder image above):
      cd lac/<your single-user demonstration package version>
      For example:
      cd lac/CALiveAPICreator-Jetty-3.0.00.8_exp20161015
    2. Start the API server by issuing the following command:
      (Windows)
      start.bat
      The following response is expected:
Screenshot of Windows command line

(Unix/Mac)

sh Start.sh
The following response is expected:
OSX Terminal showing startup output
API Creator is installed.

Start API Creator

Log on to API Creator and get started. Use the following link:

Log on and Get Started

For next steps, click Log on to Live API Creator.

More Information

Debugger

If you are using the JavaScript debuggerstart the debug services. For more information about how to start the debugger, see Debugger.

Resolve Port Conflict Issues

If you are running an application on your machine that is already using port 8080, the following error message appears:

Caused by: java.net.BindException: Address already in use
at sun.nio.ch.Net.bind0(Native Method)
at sun.nio.ch.Net.bind(Net.java:437)
at sun.nio.ch.Net.bind(Net.java:429)

Open the (for Mac) Start.sh or (for Windows) Start.bat script, and alter it as shown in red below:

echo '##########################################################################'
echo ' Starting CA Live API Creator - API Server...'
echo ' This should take a few seconds.'
echo ''
echo ''
echo ' The Stop.sh command can be used to stop this server, or you may hit Ctrl-C'
echo ' in this window.'
echo ''
echo ''
echo ' A Java installation is required.  If the server does not start, please'
echo ' verify that Java version 8 is accessible from the command line.'
echo ''
echo ''
echo ' When the message '"oejs.Server:main: Started @XXXXXms"' appears, go to:'
echo '    http://localhost:8080'
echo '##########################################################################'
echo ''
echo ''
if [ "$1" == "debug" ]"
   then
      echo "CA Live API Creator will be running in debug mode"
      LAC_DEBUG_PARAM="-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=8000"
   fi

cd CALiveAPICreator
java -DSTOP.PORT=8123 -DSTOP.KEY=stop_caliveapicreator -Xmx512M $LAC_DEBUG_PARAM -jar ../start.jar
## cd ..
## Note: if you need to run on a port other than 8080, use the following command instead:
##

java -DSTOP.PORT=8123 -DSTOP.KEY=stop_caliveapicreator -Xmx512M -jar ../start.jar --module=http jetty.port=8181
cd ..

Note: You may need to adjust the port in the Server URL when logging in, such as 

http://localhost:8181/

Next Steps

Install Node.js and the Live API Creator npm packagesFor more information about installing Node.js and the Live API Creator npm packagessee Install NodeJS.