Skip to main content

Canto — Authentication

B
Written by Ben Keeling

How to create a Canto API key for Medialake, add it to Medialake as an access key, and understand exactly what the connection can reach.



​

What to expect

Canto is connected with an API key that you create in your own Canto account. There is no Canto sign-in or consent screen during setup: nobody is redirected to Canto to log in. Instead, a Canto administrator creates an API key with Support Client Credentials Mode turned on, a Medialake administrator saves the key's App ID, App Secret, and your Canto domain as an access key, and Medialake authenticates to Canto server-side from then on using the OAuth 2.0 client credentials grant.

We follow the principle of least privilege. The Canto connector only reads content: it lists folders and albums, reads asset metadata and previews, downloads the files it syncs, and checks whether assets it has already synced are still in Canto. It does not upload, edit, move, tag, or delete anything in Canto.

 Canto administrator        Medialake                   Canto
      │  create API key with    │                         │
      │  client credentials     │                         │
      │──────────────────────────────────────────────────▶│
      │                         │                         │
 Medialake administrator
      │  save access key        │                         │
      │────────────────────────▶│                         │
      │                         │  App ID + Secret        │
      │                         │  for access token       │
      │                         │────────────────────────▶│
      │                         │  access token           │
      │                         │◀────────────────────────│
      │                         │                         │
 Team member
      │  connect, choose        │                         │
      │  folders and albums     │                         │
      │────────────────────────▶│                         │
      │                         │  read-only requests     │
      │                         │────────────────────────▶│


​

Before you begin

You will need:

  • A Canto administrator account, to create the API key. If you cannot open Settings → Configuration Options → API Keys, ask a Canto administrator to create the key for you.

  • Your Canto domain: the host name in your Canto address, for example yourcompany.canto.com or yourcompany.canto.global.

  • Administrator privileges in Medialake, to save the access key.

>Keep the credentials private. Treat the App Secret like a password. Store it in an approved password manager or secret-management system. Do not email it, paste it into a support ticket, or commit it to source control. Medialake stores the values you enter encrypted and never shows them again.


​

Step 1: Create an API key in Canto

  1. Log in to Canto as an administrator.

  2. Go to Settings → Configuration Options and open API Keys.

  3. Click Create API Key, enter a name, and click Finish. Use a key dedicated to Medialake, so you can revoke it later without affecting other integrations.

  4. Open the key, click Edit, select Support Client Credentials Mode, and click Generate. Canto shows an access token at this point; Medialake does not need it, because it requests its own tokens with the App ID and App Secret.

  5. Copy the key's App ID and App Secret.


​

Step 2: Add the credentials to Medialake

You need administrator privileges in Medialake for this step.

  1. In Medialake, open Administration → Integrations from the sidebar.

  2. Open the Canto integration.

  3. In the Access Keys section, click Create New Setting.

  4. In the New access key panel, enter a Name for the key, for example Marketing Canto app. The name is shown in the access key list and next to every account that connects with it.

  5. Under Credentials, fill in each field:

| Field | What to enter |

| --- | --- |

| Canto Client ID | The App ID from Step 1. |

| Canto Client Secret | The App Secret from Step 1. |

| Canto Domain | Your Canto host name only, for example yourcompany.canto.com. Do not enter https://, a trailing slash, or a path. |

  1. Under Who can use it?, choose the teams that can connect Canto with this key, or make it available to all teams.

  2. Click Save access key.

Medialake checks the format of each value before saving: the Client ID must be 8 to 64 letters, numbers, periods, underscores, or hyphens; the Client Secret must be 16 to 128 characters with no spaces; and the domain must be a host name such as yourcompany.canto.com.


​

Connect Canto and choose what to sync

With the access key saved, any team member who is allowed to connect sources, on a team that can use the key, can add Canto:

  1. Open Connections → Catalogue from the side menu.

  2. Find Canto and click Connect.

  3. Under Access key, select the key saved in Step 2.

  4. Optionally click Test to check the credentials with Canto before connecting.

  5. Click Connect.

There is no Canto login screen. Medialake requests an access token from Canto's OAuth service with the App ID and App Secret, then reads your Canto account's user details from your domain to identify the connection.

Nothing is synced automatically. You choose what Medialake syncs from your Canto library:

  • Folders can be opened to browse the folders and albums inside them. Selecting a folder syncs every album it contains, including albums in its subfolders.

  • Albums can be selected, but not opened. Selecting an album syncs the assets in it.

  • Unassigned collects assets that are not filed into any album. Select it to sync those assets too.

Medialake skips assets whose file type it does not support. A new Canto source syncs automatically once a week by default; you can change this to daily or monthly.


​

Limiting what Medialake can access

The folders and albums you select in Medialake control what is synced, but they do not narrow what the API key itself can reach in Canto. Protect the App Secret accordingly, use a key that exists only for Medialake, and delete it in Canto when it is no longer needed.


​

What Medialake can and cannot do

With the configuration above, Medialake can:

  • Request access tokens with the API key's App ID and App Secret

  • Read the user details of the Canto account behind the key, to identify the connection

  • List folders and albums, and the assets in the albums you select and in Unassigned

  • Read asset metadata such as names, sizes, file types, dimensions, and dates, and retrieve previews

  • Download the content of the assets it syncs

  • Check whether assets it has already synced are still available in Canto, have been moved to Canto's trash, or have been permanently deleted

Medialake does not:

  • See any Canto user's password

  • Upload, replace, edit, tag, move, or delete assets

  • Create or change folders, albums, or metadata

  • Manage Canto users, API keys, or account settings


​

Staying connected

When Canto rejects an expired access token, Medialake requests a new one with the stored App ID and App Secret and retries the request. No sign-in or user action is needed.

The connection stops working, and the source is marked unauthorized in Medialake, if Canto refuses the stored credentials, for example because the API key was deleted or changed. To restore it, create a new API key, save it as a new access key in Medialake, and switch the source to that key. To switch, open the source's General tab, click Change Key in its Access Keys section, select the new key, and click Save.

If Canto returns a temporary error or asks Medialake to slow down, Medialake waits and retries automatically.


​

Revoking access

To revoke Medialake's access from Canto, delete the API key created for Medialake on the API Keys page in Canto's settings.

In Medialake, an administrator can also delete the access key from the Canto integration's Access Keys section. Remove the Canto source in Medialake as well if it should no longer sync.


​

Troubleshooting

Symptom

What to check

"The Canto Domain format is invalid." when saving

Enter the host name only, for example yourcompany.canto.com, with no https://, trailing slash, or path.

"The Canto Client ID format is invalid." or "The Canto Client Secret format is invalid." when saving

Paste the App ID and App Secret again, checking for spaces picked up when copying.

"A setting with this title already exists in the group. Choose a different title."

Another Canto access key already uses that name. Choose a different Name.

Test reports "The provider rejected these credentials."

Check that the App ID and App Secret are from the same key, and that Support Client Credentials Mode is turned on for that key.

Test reports "These credentials look right, but the provider couldn't confirm them just now."

Canto did not give a definite answer. Check the Canto Domain value, then try again in a few minutes.

Connecting ends on an Incorrect Credentials. page

Medialake could not read your Canto account's user details from the domain in the access key. Check the Canto Domain value and save a corrected access key.

"No integration settings available for this service." when connecting

No Canto access key is available to your team. Ask a Medialake administrator to save one, or to add your team under Who can use it?

The source becomes unauthorized

The API key was deleted or changed in Canto. Create a new key, save it as a new access key, and switch the source to it.

Assets are missing from a synced folder

Only assets inside albums are synced from a folder. Select Unassigned to sync assets that are not in any album. Assets with unsupported file types are skipped.

There is no API Keys page in Canto's settings

Contact Canto support to confirm API access is available for your account.

If the issue continues, contact [email protected] with your Canto domain, the access key's name, and the error message. Do not include the App Secret.


​

Further reading


Questions about connecting Canto? Contact [email protected].

Did this answer your question?