README File for API Example

This API example demonstrates how to use the features of our API. Before running this example, make sure that you have the qblicense.jar file in the same directory as the example file.

This specific API example is demonstrating the client-server capabilities of our API. You can either use our API completely standalone (without any server) or you can use Java to control client-side features while being connected to the EspressManager server.

To run this example, you’ll need to have EspressManager running. By default, EspressManager should be running at 127.0.0.1 on port 22071. This can be changed in the source code (you’ll need to re-compile the class files if you change it). For testing purposes, you can install the trial version downloaded from our website www.quadbase.com and do the default installation.


Getting Started
To use this API example, you'll need to follow these steps:
1. If you don't have a license, download the trial version of our product from www.quadbase.com and install the product. Then copy qblicense.jar from <product install dir>/lib to <API example>/lib. If you already bought the product download the qblicense.jar file from the licensing page  www.quadbase.com and then copy qblicense.jar to <API example>/lib.
2. Make sure you have Java 1.8 or higher on your machine (Java 1.8 recommended).
3. Make sure that EspressManager is running at 127.0.0.1:22071
4. Execute the run.bat (if you’re on Windows) or run.sh file (if you’re using Linux) file.
5. Read the documentation chapter where you downloaded this example from as it will provide more details about what this example does and how to build your own applications on top of it.

License Information
The qblicense.jar file contains the licensing information required for the API to work. Without this file, the example will not function properly.

Support
If you encounter any issues while using this API example or have any questions about our API, please contact our support team at support@quadbase.com.
