Create VanillaSoft Project and/or User API Integration Key

Creating an integration within Salesforce (after the VanillaSoft Salesforce App has been installed) requires entering one or more VanillaSoft API keys. The keys can be one of two types: a User key, or a Project key.

If no API keys have been defined and the user goes to the "VanillaSoft" tab in Salesforce, the system will display the following error message:
Error: There are no API Keys configured. Please enter your user or project key by clicking the Setup button.

» Integrating with a User API Key
» Integrating with a Project API Key
» Keys Limits inside Salesforce

Integrating with a User API Key

When in User integration mode, only one User key can be used. This key provides access to a list of projects that the User has access to. In the case of an Account Admin, this would be all projects. For any other user type, it will be defined by the user restrictions configuration (to find out more, check out our Configure User Restrictions article). Team access is ignored for integration purposes.

 

Create User API Key inside VanillaSoft

  • If you are an Account Admin:
    • You can generate a key for yourself, another Account Admin, or an Admin Combo.
    • Although it is possible to generate keys for multiple users, the typical use is to generate just one key for the person who will be doing the Salesforce Integrations.
    • A key generated for an Account Admin gives the Account Admin access in Salesforce to all VanillaSoft projects, whereas a key generated for an Admin Combo gives the Admin Combo access in Salesforce to only the VanillaSoft projects the Admin Combo has access.
    • To generate an Integration Key, login to VanillaSoft, and on the Admin-side, click on the Users menu and select the Account Admin or Admin Combo. On the Edit User page, select the Integration Key tab, generate a key, and then copy that key.
  • If you are an Admin Combo:
    • An Account Admin can generate a key on your behalf (and share that key with you), or, if an Account Admin has granted you permission to do so, you can generate a key for yourself. (The Account Admin can grant you permission in VanillaSoft on the Admin Permissions page of the Admin Combo).
    • Your key gives you access in Salesforce to only the VanillaSoft projects you have access.

 

Enter User Key inside Salesforce

  1. Login into Salesforce
  2. Click the VanillaSoft tab
  3. Click the Setup button on the main page
  4. Scroll down the page and click the User Key radio button.
  5. Paste your User Key into the "Add Integration Key" field and click Verify and Save.
  6. Click the Back button at the top of the window to return to your list of VanillaSoft integrations.

For a different User key to be used, the existing one needs to be removed and then a new User key entered. If this happens, existing integrations will still be listed, but could become inactive if they key does not have access to the related project. The integrations can only be edited or re-activated if access to the VanillaSoft Project is restored via an API key.

 

Integrating with a Project Key

Each Project within VanillaSoft will be able to have a unique Project API Key associated with it. When the VanillaSoft Unite Setup is set to use Project Keys, each API key will link to that specific Project only.

 

Create Project API Key inside VanillaSoft

  1. Log into VanillaSoft
  2. Go to the Admin interface and choose the Project you want to create an API Key for.
  3. Click the cog icon beside the Project Name. This will take you to the Project Settings page.
  4. Under "Project Integration Key" click Generate New Key button.
  5. Click the Copy Key button to put the key in memory so you can enter it into Salesforce.

 

Enter Project Key inside Salesforce

  1. Login into Salesforce
  2. Click the VanillaSoft tab
  3. Click the Setup button on the main page
  4. Scroll down the page and click the Project Key radio button.
  5. Paste your Project Key into the "Add Integration Key" field and click Verify and Save.
  6. Click the Back button at the top of the window to return to your list of VanillaSoft integrations.

If a key is removed that is allowing an integration to function, the integration will still be visible but set to inactive.

 

Keys Limits inside Salesforce

  • 1 User Key OR
  • Up to 5 Project Keys

To switch from User Keys to Project Keys, you must remove all keys of the current type, then enter the new keys. For example, if you are using Project Keys and want to switch to an User Key, delete all project keys, then enter your User Key.

« Back to Salesforce to VanillaSoft Integrations Overview

Related articles