API Keys

Developers can use the Paligo API to allow other applications to interact with Paligo. For this to work, you need to generate an API key for each external application that will connect with Paligo. Paligo uses the API keys to recognize the external applications.

To generate API keys, use the API Keys settings in My Profile. You can also remove any API keys that you no longer need.

Note

Only Paligo admin users can create or remove an API key. Also, as a Paligo admin user, you can only access the API keys you have created. You cannot access API keys created by other users.

Create an API Key

  1. Select your profile name in the upper right corner to display a menu, and then select My Profile.

  2. Select the API Keys tab.

  3. Select Create New Key.

    My Profile settings showing the API Keys tab. On the API Keys tab, there is a list of the existing API keys, if any, and a Create API Key button.

    Paligo displays the Create API Key dialog.

    Create API Key dialog. It has a name field and a token field. The token field has a refresh button on the right side. The dialog also has a Create button and a Close button.
  4. Enter a Name for the key. We recommend that you give the key a descriptive name so that it is easy for other users to identify what application the key is for.

  5. Select the refresh button on the Token field to generate the key token.

    apikey-refresh.jpg

    Note

    This is the only time you will see the key in full.

  6. Copy and paste the key somewhere that is secure. You can copy the token to your computer's clipboard by selecting the copy icon to the left of the refresh button.

  7. Select Create.

  8. In your application, find the settings that allow you to connect to other applications, such as Paligo. Set up the connection to Paligo and when you need to enter the key, copy and paste it from the secure location in step 6.

    Your app should now be able to connect to Paligo.

Remove an API Key

If you have API keys that are not needed anymore, you can remove them from Paligo. When you remove a key, external applications will be unable to connect to Paligo using that key (as Paligo will not recognize the key).

  1. Select your profile name in the upper right corner to display a menu, and then select My Profile.

  2. Select the API Keys tab.

  3. Find the API key that you want to remove. Make sure that you have the correct API key and then select Remove.

    My profile settings with the API Keys tab selected. There is a list of the API keys currently in the system. It only contains one key. At the far right of the key's details, there is a red "Remove" button.