@acrolinx/sdk 中文文档教程

Question

Acrolinx JavaScript SDK

此库旨在用于与 Acrolinx 平台 API 交互在 JavaScript 集成中。 它不提供与 Acrolinx 边栏一起工作的界面（请参阅 边栏 JavaScript SDK）。

Get Started with Your Integration

Prerequisites

请联系 Acrolinx SDK 支持 用于咨询和获得集成认证。 此 SDK 中的测试使用内部 Acrolinx URL 上的测试许可证。 此许可证仅用于演示和开发目的。 完成集成后，您必须从 Acrolinx 获得集成许可。

Acrolinx 提供不同的其他 SDK，以及用于开发集成的示例。

在开始开发自己的集成之前，您可能会从以下方面受益：

• Getting Started with Custom Integrations,
• 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

Installation

npm install @acrolinx/sdk

First Steps

创建 AcrolinxEndpoint 的实例以开始。

AcrolinxEndpoint 为 SDK 提供的可用功能提供单一入口点。

有关更多示例，请参阅 Check.ts。

Example Code

Getting Some Info

import 'cross-fetch/polyfill'; // Use a fetch polyfill, when you target Node.js or IE11
import assert from 'assert';
import {AcrolinxEndpoint, DEVELOPMENT_SIGNATURE} from '@acrolinx/sdk';

const acrolinxEndpoint = new AcrolinxEndpoint({
  client: {version: '1.2.3.666', signature: DEVELOPMENT_SIGNATURE},
  acrolinxUrl: 'https://test-ssl.acrolinx.com',
});

acrolinxEndpoint.getPlatformInformation().then(info => {
  assert.ok(info.server.name.length > 0);
  assert.ok(info.server.version.split('.').length >= 2 );
  assert.ok(info.locales.includes('en'));
});

Running Samples

查看以名称 runExample 开头的脚本的 package.json 例如：runExampleXliff

如果他们需要设置任何环境变量并创建文档

示例，请查看脚本：用于运行脚本 runExampleXliff 您需要设置 $ACROLINXURL、$ACROLINXTOKEN 和一个 .xlf 文件。 将它们分别设置为 Acrolinx 平台 URL 和 Acrolinx 访问令牌。 将 .xlf 文件放在目录中并将其重命名为 sample.xlf testdocs/sample.xlf

运行脚本 npm run runExampleXliff

Contributing to this SDK

请参阅： CONTRIBUTING.md

License

版权所有 2018 年至今 Acrolinx GmbH

根据 Apache 许可证 2.0 版（“许可证”）获得许可； 除非遵守许可证，否则您不得使用此文件。 您可以在以下位置获得许可证的副本：

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

除非适用法律要求或书面同意，软件 根据许可证分发是在“按原样”的基础上分发的， 没有任何明示或暗示的保证或条件。 请参阅许可证以获取特定语言的管理权限和 许可证下的限制。

如需更多信息，请访问：https://www.acrolinx.com