Install the Single-User Demonstration Package

Install the Single-User Demonstration Package
lac31
 
CA Live API Creator
 can run in a small footprint, installed on your computer. Install the single-user version of 
CA Live API Creator
 to facilitate learning and experimentation, even if your team has 
CA Live API Creator
 installed on a centralized server for team development.
The demonstration package is based on Jetty. You can see a complete API, with logic and security, using the sample APIs that are included with the package.
The demonstration package is only for development.
The following video demonstrates how to install the single-user demonstration package of 
CA Live API Creator
.

In this article:
 
2
Install 
CA Live API Creator
Installing the demonstration 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 512 MB and a maximum of 4 GB 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 
CA 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 using API Creator.
For more information about how to test the connection to your database, see Database Connectivity.
 
CA Live API Creator
 requires the corresponding JDBC driver to the database management system (DBMS) you use as your backend data source. This demonstration package includes the following JDBC drivers:
  • MySQL JDBC driver
  • Apache Derby/JavaDB JDBC driver
  • PostgreSQL JDBC driver
  • Salesforce JDBC driver
  • Apache HBase JDBC driver
  • SAP NetWeaver JDBC driver
This demonstration package uses Apache Derby as the admin database and includes the Jetty application server.
Verify the Prerequisites
Before you unzip and run this package, ensure you have completed the following:
  • You have Java Development Kit (JDK) installed.For more information:
    You can verify your Java version by starting a command line/terminal, and issuing the following commands:
    java -version (checks that Java is installed and available)
    javac -version (checks that the JDK is installed)
  • You have at least 500 MB of free disk space.
  • You have obtained the package from the CA site.
    For more information about getting 
    CA Live API Creator
     on your computer, see the  trial page or download it from CA Support (for existing customers).
  • You have created a 
    JAVA_HOME
     environment variable and set the value to point to the JDK installation directory.
    If you have not already done this, complete the following based on your operating system:
    (Windows)
     Set the value for the 
    JAVA_HOME
     environment variable as the path to your JDK installation. If you did not change the path during installation, it is something like 
    C:\Program Files\Java\jdk1.8.0_92
    . If the path contains spaces, use the shortened path name, for example, 
    C:\PROGRA~2\Java\jdk1.8.0_92
    . Close and re-open any command line windows that you had open before you made these changes, since you cannot reload environment variables from an active command prompt. If the changes do not take effect after reopening the command window, restart Windows.
    (Mac)
     From terminal, set the 
    JAVA_HOME
     environment variable using the following command:
    export JAVA_HOME=/Library/Java/Home
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 
CA Live API Creator
 Jetty install and your APIs (such as the B2B sample APIs), as illustrated in the following image:
 
Start 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.1
  2. Start API server by issuing the following command:
    (Windows)  
    start.bat
    The following response is expected:
      CA Technologies  
    (Unix/Mac) 
    sh Start.sh
    The following response is expected:
      CA Technologies  
API Creator is installed.
Start API Creator
Log in to API Creator and get started.
For more information, see Create your API Project.
Start the Debug Services
If you are using the JavaScript debugger, start 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 in the following code snippet:
echo '##########################################################################'
echo ' Starting - 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 " 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 ..
 You might need to adjust the port in the 
Server URL
 when logging in, such as:
http://localhost:8181/
Next Steps
If you are planning to use the command-line interface (CLI) for scripted API creation or deployment, install Node.js. For general API Creator use, we recommend that you also install the 
CA Live API Creator
 npm packages.
For more information about how to install Node.js and the npm packages, see Install Nodejs.