Generic DocuSign API

The standard objects supported are Order, Opportunity, and Quote. To customize it to support other objects, see the instructions in Set Up Generic Documents For DocuSign eSignature for Custom Objects.

Overview

Before you begin, make sure that you have already set up the Contract DocuSign configuration. The Generic DocuSign API uses some of the same configurations as the Contract DocuSign. To set up the Contract DocuSign configuration, see the instructions in Setting Up DocuSign Integration.

You can then invoke the API and use it to implement different functionalities.

Invoke the API

You can use this API to implement a functionality in any one of the following:

• Apex with a custom class

• an Omniscript

• an Integration Procedure

Apex Custom Class

To use the API with an Apex custom class, follow this structure for invoking methods:

// initialize the parameters
String methodName = '[name method to invoke]';
Map<String, Object> inputMap = new Map<String, Object>();
Map<String, Object> outputMap = new Map<String, Object>();
Map<String, Object> optionsMap = new Map<String, Object>();

// setup input parameters for the method to be invoked
inputMap.put('[expected parameter 1]', [parameter value 1]);
inputMap.put('[expected parameter n]', [parameter value n]);

// setup options parameters for the method to be invoked
optionsMap.put('[optional parameter 1]', [parameter value 1]);
optionsMap.put('[optional parameter n]', [parameter value n]);

// instantiate the generic api
VlocityOpenInterface2 voi = new GenericDocuSignIntegrationService();

// invoke the method
voi.invokeMethod(methodName, inputMap, outputMap, optionsMap);

// log result
System.debug('outputMap: ' + JSON.serialize(outputMap));

Omniscript

To use the API in an Omniscript, set up a Remote Action with the following parameters:

In the Remote Properties section:

Integration Procedure

To use this API in an integration procedure, you must define a Remote Action in it. Set the following fields to define the Remote Action:

Implement Functionality

The API implementing class is GenericDocuSignIntegrationService. To access the API, call invokeMethod along with the following parameters.

global with sharing class GenericDocuSignIntegrationService 
    implements VlocityOpenInterface2
{
  ...
  ...
  Object invokeMethod(
      String methodName,
      Map<String, Object> inputMap,
      Map<String, Object> outputMap,
      Map<String, Object> optionsMap)
  {
    ...
    ...
  }
  ...
  ...
}

Note

Map parameters may be empty but cannot be null when passed.

Methods

The following methods let you view documents, recipients, notification settings, and work with envelopes.

Checks for Successful Execution

When the invoked method executes successfully, the outputMap parameter contains the following properties:

Checks for Errors

When the invoked method does not execute successfully, the outputMap parameter contains the following information:

Supported JSON Envelope Structure

The JSON envelope structure below specifies the different properties that can be used in defining a DocuSign envelope.

You can use it as a JSON string or as a Map of objects which can be submitted as parameter when invoking the sendEnvelope method of the Generic DocuSign API.

{
	"parentId": "",
	"emailSubject": "",
	"emailBody": "",
	"recipients": {
		"signers": [{
				"name": "",
				"email": "",
				"routingOrder": "",
				"recipientId": "",
				"signerRole": "",
				"emailNotification": {
					"emailSubject": "",
					"emailBody": "",
					"supportedLanguage": ""
				}
			},
			...
		],
		"inPersonSigners": [{
				"name": "",
				"email": "",
				"routingOrder": "",
				"recipientId": "",
				"signerRole": "",
				"signerName": ""
				"emailNotification": {
					"emailSubject": "",
					"emailBody": "",
					"supportedLanguage": ""
				}
			},
			...
		],
		"certifiedDeliveries": [{
				"name": "",
				"email": "",
				"routingOrder": "",
				"recipientId": "",
				"signerRole": "",
				"emailNotification": {
					"emailSubject": "",
					"emailBody": "",
					"supportedLanguage": ""
				}
			},
			...
		],
		"carbonCopies": [{
				"name": "",
				"email": "",
				"routingOrder": "",
				"recipientId": "",
				"signerRole": "",
				"emailNotification": {
					"emailSubject": "",
					"emailBody": "",
					"supportedLanguage": ""
				}
			},
			...
		]
	},
	"documents": [{
			"name": "",
			"sourceId": "",
			"fileExtension": "",
			"sourceType": "",
			"documentId": ""
		},
		...
	]
	"notification": {
		"useAccountDefaults": "",
		"reminders": {
			"reminderEnabled": "",
			"reminderDelay": "",
			"reminderFrequency": ""
		},
		"expirations": {
			"expireEnabled": "",
			"expireAfter": "",
			"expireWarn": ""
		}
	}
}

Sample Invocation Using JSON Envelope Structure

String envelopeJson = '{"parentId":"0Q06g000000F0aLCAS","recipients":{"signers":[{"name":"Test 01","email":"vlocity_test01@yopmail.com","routingOrder":"1","recipientId":"1","signerRole":"1","emailNotification":{"emailSubject":"Test","emailBody":"Test Body","supportedLanguage":"en"}}]},"documents":[{"name":"test.pdf","sourceId":"0686g000009B5ftAAC","fileExtension":"PDF","sourceType":"Content","documentId":"1"}]}';

Map < String, Object > input = new Map < String, Object > ();
Map < String, Object > output = new Map < String, Object > ();
Map < String, Object > options = new Map < String, Object > ();

input.put('envelope', envelopeJson);

// instantiate the generic api
VlocityOpenInterface2 voi = new GenericDocuSignIntegrationService();

// invoke the method
voi.invokeMethod('sendEnvelope', input, output, options);

// log result
System.debug('outputMap: ' + JSON.serialize(output));