acrolinx/sdk

PHP SDK for working with Acrolinx (without Sidebar)

v1.0.5 2022-11-15 12:09 UTC

Requires

• php: >=8.0
• ext-curl: *
• ext-json: *
• monolog/monolog: ^2.8.0
• myclabs/php-enum: ^1.7
• psr/log: ^1.1.4
• ramsey/uuid: ^4.2.3
• react/event-loop: ^1.3.0
• react/http: ^1.8
• react/promise: ^2.9.0

Requires (Dev)

• phpunit/phpunit: ^9
• victorjonsson/markdowndocs: ^1.3
• vlucas/phpdotenv: ^3.3

Apache-2.0

README

This library is meant to be used to interact with the Acrolinx Platform API in automated integrations.

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 the Acrolinx Platform API
• the Acrolinx SDKs, and
• the Acrolinx Demo Projects.

Start Developing

composer require acrolinx/sdk

Use the AcrolinxEndpoint methods to interact with the Acrolinx Platform API.

Our tests cover a lot of use cases already. Use them for inspiration.

Contributing to This SDK

Prerequisites

• Have PHP 8.0 or above installed
• Have php-curl installed
• Have composer installed Find a tutorial here.

Start Developing

• run composer install to install dependencies
• run composer update to update dependencies

Run Tests

• rename the .env.conffile to .env
• set ACROLINX_TEST_SERVER_URL and ACROLINX_ACCESS_TOKEN in this file. (Get an Access Token)
• set ACROLINX_SSO_USER and ACROLINX_SSO_PASSWORD (You can request the SSO password from Acrolinx support)
• set ACROLINX_DEV_SIGNATURE to unique signature provided for your integration. (Note: Signature and access token are different)
• run composer test to run unit tests

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.

For more information visit: https://www.acrolinx.com