Acrolinx .NET 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 .NET 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:

• Build With Acrolinx,
• 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

1. Set the environment variable ACROLINX_API_SSO_TOKEN to a valid SSO token for the Acrolinx Platform test instance you’re using.
2. Set a valid user in the environment variable ACROLINX_API_USERNAME. User custom fields must be filled out for this user.
3. Open Acrolinx.Net\Acrolinx.Net.sln with Visual Studio 2019.
4. Compile and run all tests.

Installation

NuGet

Reference the Acrolinx.Net NuGet package using the NuGet package manager.

First Steps

Create instance of AcrolinxEndpoint to begin.

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

See Acrolinx .NET SDK Demo for a quickstart example.

See EndpointTest.java for more examples.

SDK Features

1. Authenticate via SSO or API token - See: Authentication in Coding Guidance
2. Check
   • check documents,
   • set relevant parameters,
   • submit document content, and
   • access high-level results like the Acrolinx Score

See: Text Extraction 3. Content Analysis Dashboard - Aggregate all results to one dashboard

License

Copyright 2019-present Acrolinx GmbH

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.