Acrolinx Java SDK

This is a Java library to interact with the Acrolinx Platform API. It does not offer a graphical user interface (GUI) to work with the Acrolinx Sidebar (see Sidebar Java SDK).

Get Started with Your Integration

Prerequisites

Please contact Acrolinx SDK support for consulting and getting your integration certified.

Some integration tests in this SDK work with a test license on an internal Acrolinx URL. This license is only meant for demonstration and developing purposes.

Before you start developing your own integration, you might benefit from looking into:

• Build With Acrolinx,
• the Guidance for the Development of Acrolinx Integrations,
• the Acrolinx Platform API
• the Rendered Version of the Acrolinx Platform API
• the Acrolinx SDKs, and
• the Acrolinx Demo Projects.

Getting Started

Build the Project

1. You need Java 11 to build this project.
2. This project uses Gradle. To build this project with the Gradle Wrapper, execute the following command:

./gradlew build

on a UNIX system, or

gradlew build

on a Windows computer.

Using the SDK

Reference the Maven artifact com.acrolinx.client:sdk which is available on Maven Central. Have a look at the build.gradle file if you use Gradle.

References

• The DEMO Java is built based on this SDK.
• The API documentation is published on the GitHub Pages.