To connect Salesforce with HotDocs, an authorizing API credential must first be set up in HotDocs. This article walks you through registering a new API credential. To complete the steps, you must be an administrator who manages HotDocs and employee access. If you cannot access the API Management Console in HotDocs, please contact your system administrator with that level of access.
Note: Verify API Access
This integration requires HotDocs API access. To verify your site’s status, navigate to: https://[your site name].hotdocsadvance.com/auth
- Success: If the page loads without a warning banner, your API access is active and you may proceed to Step 1.
- Action Required: If a yellow banner appears stating "API access is disabled", please contact your HotDocs Account Manager to enable this feature for your tenant.
Step 1: Create a new API client
- Log in to the HotDocs Advance Auth application. The URL should be in this format:
https://[your site name].hotdocsadvance.com/auth. - Click the Manage API Credentials link.
- Click the Create a new client link.
- In the Create a new client form, enter the following information:
- Name – a descriptive name for the client, used to identify the client in the UI.
- FlowType – select a flow type of ResourceOwner from the available options list.
- Secret – an alphanumeric secret key for the client, used for authentication.
- ReturnUrl – leave it empty.
- LandingPage – leave it empty.
- Token life span – the number of seconds for which the token is valid, maximum value supported is 259200.
- Scope – select Command as the scope from the available options list.
- Click the Create button.
Copy the UniqueName value somewhere so it can be used later for completing the Set Up HotDocs Configuration in Salesforce.
(HotDocs Advance will generate this value after client save.)
Step 2: Add a service principal to the client
- After completing Step 1 above, the client's details page should already be open for you. If not, click the Manage API Credentials link on the screen, then click the Details link for the API client row in the displayed table.
- Under the Client service principal section, click the Add a service principal button.
- Enter the following information into the Add a service principal for the client form:
- PrincipalName – the name of the new service principal.
- Password – (Optional) an automatically-generated password appears in this field; you can change it to your own custom password, if necessary.
Note: You must remember this password; it cannot be viewed again beyond this page. - IsActive – check this box to make the service principal available for making requests to the API.
- Click the Create button.
Copy the PrincipalName and Password values somewhere so they can be used later for completing the Set Up HotDocs Configuration in Salesforce.
Step 3: Activate the API client
- After completing Step 2 above, the client's details page should already be open for you. If not, click the Manage API Credentials link on the screen, then click the Details link for the API client row in the displayed table.
- Under the Client Actions section, click the Activate Client button.