Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

When setting up a new integration on Canvas, the first step is to register the applications we want to connect.

Canvas handles API authentication for you, simplifying the process while ensuring safe handling of sensitive data.

When you register a new application on a user account you will be asked to provide the API credentials (usernames, passwords, API keys, etc.) which will be used by the integration.

These details are then stored safely in the user
Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#DEEBFF
Info

If you are setting up an integration for a client we recommend that you add the app to the client’s own account, i.e. a separate account set up by/for the client.
As a Canvas partner you will have admin permissions for your clients' accounts. So you can add the app for them, or if you prefer not to handle the credentials you can ask them to add it themselves to their account, as described in this article.
Also see this article for info on how to manage a client account.

To add an application to the user account, go to the Applications section and click the + sign in “Add new appliaction” button at the top right cornerof the screen:

...

Select the application you want to connect to. We are going to add “Talent Manager 2”, you can search for the app you want at the top of the page. Click “Configure“ on the app you want to set up.

...

Enter the requested credentials, and give the application a descriptive name, and press Authenticate to save.

...

Note

...

The credentials will not be visible after saving. It is therefore important to give the app a descriptive name

...

(for example by appending the company name, as shown in the screenshot) to avoid confusion later on.

If authentication fails you will receive an error message. Otherwise the credentials will be stored in an encrypted vault for later use.

Repeat this process to register applications for all other apps that will be part of your integration.

...