Configuring the Design Editor

To display Amazon S3 assets in the Asset Manager, you must configure this asset source in ~\Configuration\clientConfig.json and define the X-GoogleDriveAPIKey request header in ~\Configuration\AssetSourcesConfig.json.

This topic describes how you can configure the Design Editor to access Amazon S3 assets.

Defining the Asset Source

Now that you have set up and run GDWS, you can define the Amazon S3 source as follows:

json
{
    "assetSources": {
        "[source]AmazonS3": {
            "type": "RemoteSource",
            "url": "https://gdws.example.com/"
        }
    },
    "widgets": {
        "AssetManager": {
            "tabs": [{
                "name": "Amazon",
                "assetSourceInstance": "[source]AmazonS3"
            }]
        }
    }
}

Here, we only specified the URL to the running instance of GDWS. To learn how to fine-tune this asset source, you can refer to The Asset Manager topic.

In addition to the parameters responsible for displaying images, you must pass the user ID (representing a folder in your bucket) and a token in the editor's config. The following topic describes how you can generate and pass tokens.

Parameters of the Web API

The Design Editor uses the Web API to render print files. For the security policy, you must specify hi-res secret keys for remote sources in the ~\Configuration\AssetSourcesConfig.json file. This file looks as follows:

json
{
    "[source]AmazonS3": {
        "type": "RemoteSource",
        "hiResSecret": {
            "httpHeader": "X-GoogleDriveAPIKey",
            "secret": "UniqueSecurityKey"
        }
    }
}

Here, the object name "[source]AmazonS3" corresponds to the asset source name defined in clientConfig.json. The httpHeader is a parameter of your request payload. To render images hosted on Amazon S3, you need to pass the X-GoogleDriveAPIKey header. The value of the secret property corresponds to the ApiSecurityKey value specified in the Web.config file when setting up the web service supporting the Amazon API.

Now that you have configured the general parameters, you can move further and learn how to generate user-specific tokens and pass them into the editor.

See Also

Manual