The Weagree Wizard’s DocuSign integration allows the user to initiate e-signing of all contracts and schedules in the Weagree Wizard. Intermediate receipts (of opening, reading and signing) by either signatory are automatically handled by the Weagree Wizard and returned e-signed contracts are automatically stored with the correct contract entry.
DocuSign integration can be enabled and configured as follows:
To start setting up your DocuSign integration, you will need a (free) DocuSign developer account. If you do not have one already, first create one here. Then continue with the steps below.
1. Log in to DocuSign and click on Settings at the top of the page.
2. Click Apps and Keys beneath Integrations on the left-hand side of the page.
3. Click Add app and integration key.
4. The pop-up Add Integration Key will appear. Fill in the App Name field (you are free to choose any name).
5. Click Create app.
6. The settings page for the newly created app will load. Check if User Application is set to Authorization Code Grant.
7. In the Authentication section, click Generate RSA.
8. The pop-up RSA Keypair will appear. Click the copy icon next to the private key.
9. The private key will need to be saved as a PPK file. A simple flat-text editor such as Windows’ Notepad will suffice.
a. Open the editor and paste the copied text into it (including “—–BEGIN RSA PRIVATE KEY—–” and “—–END RSA PRIVATE KEY—–“).
b. Save the document by inserting “[document name].ppk” into the file name field, with quotes (e.g. “DocuSign key.ppk”).
Note: If you are using an editor that supports text formatting (e.g. Microsoft Word), ensure that the selected file type produces flat, non-formatted text (e.g. TXT). Otherwise, saving it with a PPK extension as described above will not work as intended.
10. In the Additional settings section, click Add URI.
11. In the Redirect URIs field that appears, insert a link with the following format:
For [portalname], substitute the first part of your Weagree portal’s address (e.g. “cycling” if the full address is “https://cycling.weagree.com/”).
12. Click Save.
13. The main Apps and Keys page will load again. At this point, it would be useful to copy and paste the following to a temporary document as they will be needed a little later:
a. User ID
b. Your app’s Integration Key
B. WEAGREE WIZARD
Having set up the DocuSign app, the Weagree Wizard must be configured to connect to it.
1. First, ensure that API integrations are enabled. If you open the Configuration Weagree Wizard item on the Administrator page, and no subitem API integrations appears in the list on the left, they are currently disabled. In that case, open the subitem Key functionalities. On the main part of the screen, move the API integrations slider to the right (i.e. “ON”) position and click Save.
2. Open the Key management subitem to upload the PKK file you created earlier:
a. Click Insert.
b. Insert a name (this does not have to match the file name).
c. Select the file from your hard drive or network or drag-and-drop it.
Note: in the file browser, the default filter might hide PPK files. In that case, change the dropdown filter to show all files.
d. Click Save.
3. Open the API integrations subitem (that has now appeared) to configure the DocuSign integration:
a. Select DocuSign from the plugin list. Its settings will be displayed on the right.
b. Set the top switch to the “ON” position to activate DocuSign integration. After activation, a grey checkmark will appear in the plugin list’s right column.
Note: ensure that no other e-signing plugin has been activated. If so, switch it “OFF” and click Save. Continue with the DocuSign settings.
c. Set the second switch to the “ON” position to activate DocuSign’s e-signing functionality (other APIs may have multiple, independent functionalities).
d. For ClientID, insert the DocuSign app’s Integration Key.
e. For AuthServer, insert: account-d.docusign.com
f. Click the magnifier icon to select the uploaded PPK file.
g. For ImpersonatedUserID, insert your DocuSign developer app’s User ID.
h. Click Save.
1. To finalise the connection, a one-time authentication procedure must be followed. This requires accessing a specific internet address. It must use this format:
a. For [integrationkey], substitute the DocuSign app’s Integration Key (without brackets).
b. For [portalname], as before, substitute the first part of your Weagree portal’s address (again without brackets).
c. Insert the resultant URL into your browser’s navigation bar and hit Enter (Return).
2. Should DocuSign produce an error when inserting the URL, doublecheck these criteria:
a. Authorization Code Grant has been selected for the DocuSign app.
b. The redirect URI added to the DocuSign app is correct. Ensure that it begins with “https://” and ends with “signtransaction.docusign” (no period or other character at the end).
c. There are no typos in the inserted URL (e.g. “http” instead of “https” or a missing % in the embedded URI at the end).
d. The inserted URL’s response_type is “code”.
3. If all previous steps have been correctly executed, you will be prompted to (login and) grant permission. (Login and) click Allow access.
4. The DocuSign integration is now set up for the developer account. DocuSign requires that at least 20 successful API calls are made to the newly configured app before it can go live. You will therefore need to e-sign a number of (test) documents before the app’s settings can be transferred to your DocuSign’s production environment. When going live, the AuthServer field will need to be changed to point to your production account’s data center location. The other settings may remain as they are. For more information, see the DocuSign Go-Live page.