Import from Word - quick start

The aim of this article is to get you up and running with the Import from Word service.

Follow these steps:

• Subscribe to Import from Word on the Premium Features Free Trial website.
• Generate your access credentials in the CKEditor Ecosystem customer dashboard.
• Configure CKEditor.

All the steps are explained in details below.

# Subscribe to CKEditor Cloud Services

Create an account in CKEditor Cloud Services by signing up to the Import from Word service. After signing up, you will receive access to the customer dashboard (CKEditor Ecosystem dashboard).

# Log in to the CKEditor Ecosystem dashboard

Log into the CKEditor Ecosystem customer dashboard and navigate to “Your products > Cloud Services”.

From the list of available subscriptions in the dashboard, choose the Import from Word subscription that you want to manage and press the “Manage” link.

On the next page, you will see the subscription parameters overview together with the management area below.

# Using the service with REST API

The Import from Word service may be used to convert Word files into the HTML data. In order to use it, authorization is needed in the form of an authorization token.

The authorization token needs to be passed as a value of the Authorization header.

{
     'Authorization': 'Your generated authorization token'
}

# Generating the authorization token

The authorization token can be generated in two ways:

1. As a value returned from the security token endpoint.
2. A locally created token.

# Creating access credentials

From the list of environments, select the one that you want to manage (or create a new one).

Go to the “Access credentials” tab and click the “Create a new access key” button.

A modal will show up and will prompt for a name for the new access key. Provide the name and click the “Save” button.

The newly created access key will be present on the list of access keys.

The value of the new access key will be hidden. To show the value, click the “Show” button in the “Actions” column.

For your safety, the access key value will disappear in a few seconds. You will be able to display it again by clicking the “Show” button. Make sure to keep the access credentials in a safe place.

Read more about dealing with the credentials in the Managing access credentials section of the Environments management guide.

# Example request

Tokens for the Import from Word converter service require passing a payload with the aud parameter:

• aud – The environment ID.

The accessKey value needs to be replaced with your own access key generated before.

The following example presents a request that contains the required Authorization header for the converter:

const fs = require( 'fs' );
const jwt = require( 'jsonwebtoken' );
const axios = require( 'axios' );
const FormData = require( 'form-data' );

const accessKey = 'iGC6md5EcTG0DDZqEf4m4eytr679z0Ch2gIQuraBPzyWEtTbcpQAqAhA9LxpkDtpn';
const environmentId = 'DO3zekDU3LiJX8GOL2xt';

const token = jwt.sign( { aud: environmentId }, accessKey, { algorithm: 'HS256' } );

const config = {
    headers: {
        'Authorization': token
    }
};

const conversionConfig = {
    default_styles: true,
    collaboration_features: {
        user_id: 'example_user_id',
        comments: true,
        track_changes: false
    }
};

const file = fs.readFileSync( './file.docx' );

const formData = new FormData();

formData.append( 'config', JSON.stringify( conversionConfig ));
// The file needs to be added as the last property to the form data.
formData.append( 'file', file, 'file.docx' );

axios.post( 'https://docx-converter.cke-cs.com/v2/convert/docx-html', formData, config )
    .then( response => {
        console.log( 'Conversion result', response.data );
    } ).catch( error => {
        console.log( 'Conversion error', error );
    } );

Please refer to the converter documentation to start using the service.

# Using the Import from Word feature as a plugin

In order to use the Import from Word feature in your CKEditor 5 build, a token URL is needed for authorization.

# Creating token endpoint

Before you can use the feature, you first need to create a security token endpoint in your application. The role of this endpoint is to securely authorize end users of your application to use CKEditor Cloud Services only if they should have access to the content or action they are requesting.

# Development token endpoint (development only)

If you are just starting, you may use the development token endpoint URL, which is available out of the box and requires no coding on your side. The URL of the development token endpoint can be obtained easily in these three simple steps:

1. To work with CKEditor premium features like real-time collaboration, exports or Easy Image, you need to create an environment. Environments allow you to create access credentials, manage webhooks, configure features and connect to CKEditor Cloud Services. You may have more than one to serve separate instances or integrations. From the list of the environments, choose the one that you want to manage or create one.

2. After choosing the environment, press the “Generate” button in the “Development token URL” section of the “CKEditor configuration” tab:

The development token URL will show up in the “Development token URL” section:

# Writing your own token endpoint (production)

To write your own security token endpoint, you need to create access credentials for the selected environment by going to the “Access credentials” tab and clicking the “Create a new access key” button.

Read more in the Creating access credentials section of the Environments management guide.

# Integrating the Import from Word plugin with the application

To install the plugin into your WYSIWYG editor, use the online builder to generate a custom CKEditor 5 build with the plugin enabled. Alternatively, refer to the installation guide in the plugin documentation to do it on your own.

Configure the plugin using the token generated earlier, pasting the link in the configuration (see CloudServicesConfig):

    ClassicEditor
        .create( document.querySelector( '#editor' ), {
            importWord: {
                tokenUrl: 'https://example.com/cs-token-endpoint',
            }
        } )
        .then( ... )
        .catch( ... );

This is all. At this point, the Import from Word feature will be automatically enabled in your application.

Refer to the Import from Word guide if you need more information on integrating Import from Word with your WYSIWYG editor!