Acrolinx Java SDK

This library is meant to be used to interact with the Acrolinx Platform API in automated integrations. It does NOT offer an interface 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. The tests in this SDK work with a test license on an internal Acrolinx URL. This license is only meant for demonstration and developing purposes. Once you finished your integration, you'll have to get a license for your integration from Acrolinx.

Acrolinx offers different other SDKs, and examples for developing integrations.

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

Getting Started with Custom Integrations,
the Guidance for the Development of Acrolinx Integrations,
the Acrolinx Platform API
the Rendered Version of Acrolinx Platform API
the Acrolinx SDKs, and
the Acrolinx Demo Projects.

Start Developing

Installation

Maven

<dependency>
    <groupId>com.acrolinx.client</groupId>
    <artifactId>sdk</artifactId>
    <version>1.0.6</version>
</dependency>

Gradle

repositories {
    mavenCentral()
}

dependencies {
    implementation 'com.acrolinx.client:sdk:1.0.6'
}

First Steps

Create instance of AcrolinxEndpoint to begin.

AcrolinxEndpoint offers a single entry point to avail features provided by the SDK.

See the Acrolinx Java SDK demo for a quickstart example.

See CheckTest.java for more examples.

See the Java SDK Documentation.

Integration Tests

In order to run the integration tests locally:

You need access to the Acrolinx Platform
You need to create an .env-file similar to the .env.template file. Alternately you can set the corresponding environment variables in a different way.

Contributing to This SDK

See: CONTRIBUTING.md

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at:

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

tkrisztian95/sdk-java