Version 23.0.8844

• System Requirements
  • Windows
  • Unix / Mac
  • Internet Connection
• Downloading and Installing
  • Windows Edition
  • Java Edition
    • (Optional) Installing the Service

These pages outline the process of installing and configuring API server for your platform.

System Requirements

API Server requires at least the minimum specifications listed below.

Windows

• Windows 10/Windows Server 2016 or higher. To use earlier versions of Windows, you must host the application in IIS.

• .NET Framework 4.5 or higher.

• 1 GB RAM required. 2+ GB RAM recommended.

Unix / Mac

• Java version 11 or higher.

• Java servlet container, such as Tomcat, JBoss, WebLogic, WebSphere, or Jetty.

• 1 GB RAM required. 2+ GB RAM recommended.

Internet Connection

If you configure the application to connect with external systems, you may need the following resources:

• A persistent internet connection

• An external IP address for the system running the application

• Firewall/proxy access to communicate with the external system

Downloading and Installing

Download the latest version of API Server and follow the installation steps below for your operating system.

Windows Edition

Run setup.exe and proceed through the installation steps. When the installation finishes, see Windows Edition for information about running and configuring the server.

Java Edition

The Java setup file ships in a compressed archive as CDataAPIServer.zip. Extract the contents of the archive to your installation directory, and then see Java Edition for information about running and configuring the server.

(Optional) Installing the Service

To install API Server as a service on Linux platforms, run the service file in the application installation directory. This file is a service installation script that allows you to start, stop, and restart the embedded Jetty server as a Linux service.