Install the Single-User Demonstration Package
Install the Single-User Demonstration Package
CA Live API Creatorcan run in a small footprint, installed on your computer. Install the single-user version of
CA Live API Creatorto facilitate learning and experimentation, even if your team has
CA Live API Creatorinstalled 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 this demonstration 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:
Installing the demonstration package involves installing the API Server. When installing the 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 Creatorclose 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 Creatorrequires 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
- Apache Cassandra JDBC driver
- CSV JDBC driver
You can connect to other backend data sources where the demonstration package does not include the JDBC driver.
For more information about how to install other JDBC drivers, see the "(Optional) Install Other JDBC Drivers" section.
This demonstration package uses Apache Derby as the admin database and includes the Jetty application server. You can manage the content in your data source using Derby as your admin database.
Verify the Prerequisites
Before you unzip and run this package, ensure that you have completed the following:
- You have Java SE 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 created aJAVA_HOMEenvironment 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 theJAVA_HOMEenvironment variable as the path to your JDK installation. If you did not change the path during installation, it is something likeC:\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 theJAVA_HOMEenvironment variable using the following command:export JAVA_HOME=/Library/Java/Home
- You have at least 500 MB of free disk space.
Unzip and Run the Package
Unzip and run the file to a local directory. We recommend creating a directory (for example,
lac) to contain the demonstration package and your APIs (such as the B2B API samples), for example:
lac/<your demonstration package version>
The following image illustrates the folder structure:
CA Live API Creatoris installed.
Start API Server
- From a command window (terminal or cmd), change directories to the location of your installation by issuing the following command (see the install folder in the previous image):cd lac/<your demonstration package version>For example:cd lac/CALiveAPICreator-Jetty-4.0
- Start API server by issuing the following command:(Windows)start.batThe following response is expected:(Unix/Mac)sh Start.shThe following response is expected:
Start API Creator
Log in to API Creator and get started. You access API Creator using a browser URL, which starts with a logon authentication dialog.
- In your browser, enter a URL similar to the following:http://localhost:8080/APICreatorThe API Creator log in authentication dialog opens.
- Complete the following fields, and then clickLogin:ServerThe URL and location of API Server, which can include the name of the root web application archive (WAR) file.Example:/APIServerThe server location and name depends on the type of installation and configuration of your API.UsernameThe admin account's username. Enteradmin.PasswordThe admin account's password. EnterPassword1.
- If this is your first time logging in to API Creator, accept the terms of the End User License Agreement (EULA). You must accept these terms before you can use API Creator.
You are logged in to API Creator as the administrator user (admin).
(Optional) Install other JDBC Drivers
Follow these steps:
- Copy the JDBC driver into the%JETTY_HOME%/caliveapicreator/lib/extdirectory.
- Stop and restart API Server.
The data source is now available as an option in the connection wizard when creating an API.
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)
To resolve this port conflict issue, open the (for Mac)
Start.shor (for Windows)
Start.batscript, and then alter the
LAC_PORTvalue to a different port number.
You might need to adjust the port in the URL when starting API Creator, such as:
Configure Offline Viewing of API Server Logs
You can create a logger for externalizing your API logs.
For more about how to configure offline viewing of API Server logs, see External Logging.
Now that you have installed the demonstration package, you can install Node.js and the
CA Live API Creatornpm packages.
For more information about how to install Node.js and the npm packages, see Install Nodejs.