Connector for Canto configuration properties
Implementing the Connector for Canto requires a JSON configuration file, which defines your specific integration of Tridion with Canto.
File structure
This connector's configuration file defines two connector deployments:
- CantoDAMConnector — includes the capabilites to list, open and display the external items
- CantoDownloadsConnector — includes the capabilites to download the external items
Properties
This section describes the configuration properties that are needed specifically for the Connector for Canto. For full details on the standard connector configuration format, refer to the related topics.
- pageSize
- Default page size when doing search and list operations.
- url
- The URL to the REST API endpoint of the assigned Canto instance.
- appId
- The API username defined in Canto instance.
- appSecret
- API password to be used to authenticate over OAuth.
- accessTokenUrlPath
- The URL to use to get the access token that will be used for authentication.
- oauthDomain
- Domain for authentication through OAuth.
- user
- The email of the Tridion user.
- tenantDomain
- The main domain for the Canto API.
- mdcProtocol
- Protocol for Media Delivery Cloud URLs.
- mdcDomain
- The TLD (top-level domain) for Media Delivery Cloud.
- mdcAwsAccountId
- AWS Account ID used by Media Delivery Cloud.
- mdcUrl
- A tokenized URL that uses the preceding values at runtime to provide the Media Delivery Cloud URL when published DXA R2 JSON.
- approvedOnly
- A Boolean value (true/false) that indicates whether to display only approved Canto assets (value=
true). - imageDownloadType
- The type of download for images.
- documentDownloadType
- The type of download for documents.
- scheme
- A list of media types that the connector deployment will support.
- cache
- A Boolean value (true/false) that indicates whether to cache API responses. Set to
trueto cache. - cacheDurationSeconds
- When caching is enabled, sets how long (in seconds) to cache API responses.
- namespaceName
- The namespace name you want to use for each of the two connector deployments.
- customFields
- An array of custom fields from Canto.
- customFieldApiProperty
- Additional fields from the Canto API.
Example
The following sample code illustrates the configuration file of a Connector for Canto:
{
"configuration": {
"CantoDAMConnector": {
"configuration": {
"pageSize": 50,
"appId": "123456789abcdefg",
"appSecret": "aFakeClientSecret_secret123",
"oauthDomain": "https://oauth.canto.global",
"accessTokenUrlPath": "/oauth/api/oauth2/token",
"user": "support@rws.com",
"tenantDomain": "https://kaeser.canto.global",
"mdcProtocol": "https",
"mdcDomain": "d15gaovuyz6h3b.cloudfront.net",
"mdcAwsAccountId": "123456789",
"mdcUrl": "{mdcProtocol}://{mdcDomain}/rendition/
{mdcAwsAccountId}/image_{assetId}/-FWEBP",
"approvedOnly": true,
"imageDownloadType": "mdcUrl",
"documentDownloadType": "binary",
"scheme": [ "image" ],
"cache": true,
"cacheDurationSeconds": 120,
"namespaceName": "can",
"customFields": [
"Total frames (360view)",
"Total number columns (360view)"
],
"customFieldApiProperty": "additional"
}
}
"CantoDownloadsConnector": {
"configuration": {
"pageSize": 50,
"appId": "123456789abcdefg",
"appSecret": "aFakeClientSecret_secret123",
"accessTokenUrlPath": "/oauth/api/oauth2/token",
"user": "support@rws.com",
"tenantDomain": "https://kaeser.canto.global",
"mdcProtocol": "https",
"mdcDomain": "d15gaovuyz6h3b.cloudfront.net",
"mdcAwsAccountId": "123456789",
"mdcUrl": "{mdcProtocol}://{mdcDomain}/rendition/
{mdcAwsAccountId}/image_{assetId}/-FWEBP",
"approvedOnly": true,
"imageDownloadType": "mdcUrl",
"documentDownloadType": "binary",
"scheme": [ "image", "document" ],
"cache": true,
"cacheDurationSeconds": 120,
"namespaceName": "dow",
"customFields": [
"Total frames (360view)",
"Total number columns (360view)"
],
"customFieldApiProperty": "additional"
}
}
},
"sitesCm": {
"isEnabled": true,
"CantoDAMConnector": {
"namespaces": {
"can": {
"displayName": "Canto DAM",
"stubFolders": [ "tcm:8-515-2" ],
"logLevel": "DEBUG"
}
}
},
"CantoDownloadsConnector": {
"namespaces": {
"dow": {
"displayName": "Canto Downloads",
"stubFolders": [ "tcm:2-36-2" ],
"logLevel": "DEBUG"
}
}
}
}
}