Documentation Center

Prerequisites for the Content Delivery RESTful API

The RESTful API only requires Java or .NET, and will run on any web application server that supports the required version(s) of Java or .NET.

Java

You require a Java Runtime Environment (JRE). Such a JRE must be contained within either of the following Java Development Kits (JDKs):
  • Eclipse Temurin OpenJDK 17 (formerly AdoptOpenJDK OpenJDK 17) using the Hotspot JVM (recommended)
  • Oracle JDK 17

Both of these are fully supported; no version of Java is deprecated.

Download Eclipse Temurin OpenJDK 17 from this location: https://adoptium.net

Whichever JDK you select, you only need the JRE inside it. So, depending on your preference, you can do one of the following:
  • Install the entire JDK
  • Use the jlink command to install only the JRE part of the JDK.

After installation, you must ensure that the JAVA_HOME variable is set and refers to this Java instance.

.NET Framework

Alternatively, you can use one of the following versions of the Microsoft .NET Framework:
  • Microsoft .NET Framework 4.8.1 (if your operating system is Microsoft Windows Server 2022)
  • Microsoft .NET Framework 4.8.0 (if your operating system is Microsoft Windows Server 2019 x64)

Web application server

The RESTful API works with any web application server that supports the Java or .NET Framework versions listed above.

Additionally, IBM WebSphere 8.5.5.22 , Oracle WebLogic Server 12c R2 and Oracle WebLogic Server 14c, even though they do not support any of the Java instances listed above, are supported, provided that you use version 11.6 of the Content Interaction Libraries, which are available online through Maven.