# SalesForce Integration Installation Tutorial

### Introduction and Prerequisites

This article is a tutorial on the necessary steps that you need to take to install our LicenseSpring SalesForce integration on your SaleForce instance.

We are assuming that you have a **SalesForce** **instance** and a **LicenseSpring instance** setup beforehand and that you have the **admin rights** needed to install applications on it and edit / add **Lightning Record Pages.**

### App Installation

The integration is a SalesForce app that can be installed by using the following link:

<https://login.salesforce.com/packaging/installPackage.apexp?p0=04tgK000000BdSfQAK>

{% hint style="info" %}
The App is currently not published on the SalesForce marketplace, but we are planning to do so in the future so users will be able to find the app on the SalesForce marketplace as well.
{% endhint %}

Once you **click** on the **link** and log into your **SaleForce instance** you will be shown the following page:

![](/files/14f05792bfe353f42599354cdd9840da8e744d1e)

On this page you have the ability to pick who will be able to use the app in your SF instance (the choice does not matter from the perspective of the integration so choose whichever you prefer for your use case).

After you choose the permission setting, you will need to check the check mark "I acknowledge that I'm installing a Non - Salesforce Application" and then click on the "Install" button.

This will take you to a loading animation.

![](/files/982ffb23f7e6555363dfe3b4e045952e8a8b9d3a)

If everything is installed correctly you will be shown the following message: "Installation Complete!".

![](/files/7414faa714e0f0b18e20e6cdf89173412467b3ad)

### Lightning Pages Setup

Now the application is installed and we need to add the application's UI to the **Contacts** and **Accounts** **Record pages** so that we are able to see and use our integration on those Lightning Pages.

{% hint style="warning" %}
Our integration currently supports the **Contacts** and **Accounts** SalesForce objects.

The integration only works in the SalesForce **record** pages. You are able to add the integration to any Lightning page types, but it won't work properly.

If you need the integration to work with other SF **objects** or on other **Lightning page types** please submit a support ticket to our support team: <https://licensespring.zendesk.com/hc/en-us/requests/new>
{% endhint %}

Go to the **Setup** page.

![](/files/9f6cb4c43656861acfed8a89581f6062e1b13225)

On the Setup page, click on the **Lightning App Builder**.

![](/files/0d47741fca67aee05e4489249549ea772e04b120)

{% hint style="info" %}
There may already be Lightning pages listed in your SalesForce instance.
{% endhint %}

Click on the "New" button if you do not already have a **Lightning record page** for the **Contact** and **Account** objects.

{% hint style="warning" %}
If you do have a **Lightning record page** for the **Contact** and **Account** objects, you will need to click on the **Edit** button on those pages. This will take you to the Lightning Page editing tool, so you can skip the next few steps of the tutorial by clicking on the link for the "Lightning Page editing tool / Lightning App Builder".
{% endhint %}

![](/files/d7bb7d518ebc6ac12d055323a6b1dfcf2217ee11)

In the above step, click "Record Page" and click the "Next" button.

You will be prompted to create a **label** and pick an **object** for the Page.

![](/files/0de02fd675f2c96f2cf7796c1e4df0a6b40b10df)

For the **label** you can put anything you like, but make sure it is **recognizable** (in our case we will put "ContactRecordPage"), and for the **Object** you need to pick "**Contact**".

![](/files/107dcbec72c9caf88a10dfa92eab3098b00ce664)

After you click next, you will need to pick a **template**, or clone an existing page. Choose whatever is the best for your use case and click "Done".

#### Lightning Page editing tool / Lightning App Builder

Once that is done, you will be redirected to the editing tool for the newly created **Lightning Page** (or an existing page).

![](/files/3aa887ff19b2c5a472c57d368eb19ccb81870120)

{% hint style="info" %}
If in the steps above you have picked to edit an already existing Contact or Account record page, you would be redirected to this editing tool.
{% endhint %}

On this step you will add the LicenseSpring integration's UI component to the Page.

You can do so by scrolling to the bottom of the component list on the left side of the screen, or by searching for the "contactLicensesPreview" component.

![](/files/4b8f457fc7e2027404a0c2272bacae8c3c6d40c7)

To add the component, you will need to drag and drop the **contactLicensesPreview** component to an empty slot on the page where you wish for our integration's UI to be shown later on.

![](/files/dac506ce4b43043fd6cac0636a2de9fa63fce59f)

In the example, we have also added the "Record detail" component just to have more information on the page.

When our component is added, click "Save", and click "Activation...".

This will take us to the Activation wizard. On this wizard you have additional options on how to show / use the page. You decide on how / where you want to show the page. For this example, we will click on "Assign as Org Default" and after a couple of more custom options that you can choose based on your use case you are done with the integration setup for the **Contact** object.

![](/files/5932763884c575554609f6ebeef6de2f625384a1)

Repeat the steps on the **Account** object and its Lightning page.

{% stepper %}
{% step %}

### Create or edit Account Lightning Record Page

Go to the **Lightning App Builder**.
{% endstep %}

{% step %}

### Add a new Account Record Page

Add a new Account Record page or edit an existing one.
{% endstep %}

{% step %}

### Add the component

Add our **accountLicensesPreview** component to the page.
{% endstep %}

{% step %}

### Save and activate

Save the page and activate it.
{% endstep %}
{% endstepper %}

#### Management Api Key

Now when we have **installed** the app and added the needed component to our **pages** we can go to any **Contact** or **Account** record and we should be able to see the integration window.

To do so we need to go back to the SalesForce home page, click on the upper left "9 dots" icon, and search for **Contacts** or **Accounts**.

![](/files/85e84fa7b0eea889c80b5970cc643c35a0d0b2af)

The last step in the integration setup is for us to set the **LicenseSpring Management API key.**

To do so, log into the [LicenseSpring Vendor Platform](https://saas.licensespring.com/), click on the **Settings** and click on the "Keys" tab.

![](/files/198d7955533093652d9480d1110d62d1e33c443a)

On this tab, we need to copy our Management API key that is **active** and is **not read only.**

Paste the key in the text field SalesForce integration Management api key field and click on the "Set Key" button in the lower right corner of the integration window.

{% hint style="warning" %}
If users who are not system administrators are going to use the integration, they must be assigned the **LS\_Admin** permission set. In addition, they need the standard object permission **User External Credential** granted. This permission cannot be assigned through the installed package and must be granted manually, as explained [here](https://help.salesforce.com/s/articleView?id=ind.fsc_admin_enable_user_access_to_user_external_credentials_object.htm\&type=5).
{% endhint %}

### Additional Steps for Single-Tenant Instances

If you are using a single-tenant instance, you’ll need to update the Named Credential URL to point to your dedicated **integrations** instance. Go to Setup → Named Credentials, locate the **LS credential**, click Edit, and update the URL accordingly.

By default, the URL is [https://integrations.licensespring.com](https://integrations.licensespring.com/), but your instance will have its own integrations endpoint so you'll need to use that endpoint. If you are not sure what endpoint you are using, contact our support team, and they will help you find it.

![](/files/d391e6cc2e43b0172e788f0a9b77f3c3ccad9389)

![](/files/6b13f2b4f82564d9e4161124d311dc6cb4109acc)

### Contact Support

If you still have issues with the setup, need answers to certain questions or need additional functionalities added to the integration, feel free to contact our LicenseSpring support team: <https://licensespring.zendesk.com/hc/en-us/requests/new>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.licensespring.com/integrations/salesforce/salesforce-integration-installation-tutorial.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.