Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Callback E-Sign Integration is for customers who want to use Quik! Forms directly with DocuSign without having to play a part in calling the DocuSign APIs to kick off the signing process. This methodology was specifically designed for customers using SalesForce.com and similar systems where it is difficult or impossible to intercept a POST from the form in order to call the DocuSign APIs. 
While this method will start the e-signing process, customers will still need to call the DocuSign APIs for other functions (e.g. to check for status, to download the final signed document, etc.). The assumption in this model is that the customer has an existing account with DocuSign and sets up an OAuthToken (see next section on setting up the OAuthToken) with Quik! to call the API on behalf of the customer. An OAuthToken can be established via web service or manually by request. This integration method is optimal for retail or individual customers, or enterprise-level customers who need a streamlined method to start the envelope process (e.g. SalesForce users).

...

  1. OAuthToken – Set up a token by request or via web service call (use ApplicationID = 3): https://websvcs.quikforms.com/Docusign/ESignWSVersion/5400/OAuthToken.asmx 
    1. Use ApplicationID = 3 (Quik! Forms Engine application ID)
    2. Set the SignEnvironmentID (see values below) and set up an OAuthToken for each environment you're actively using. For help with which environment you use, see: https://www.docusign.com/results?qu=post%20api%20certification
      1. 1 for DocuSign production accounts on NA1 (www.docusign.net)
      2. 2 for DocuSign DEMO accounts (demo.docusign.net)
      3. 3 for DocuSign production accounts on NA2 (na2.docusign.net)
      4. 4 for DocuSign production accounts in Europe on EU1 (eu1.docusign.net)
      5. 5 for DocuSign Preview accounts (preview.docusign.net)
  2. Set up a URL on your application or server to receive the DocuSign EnvelopeID
  3. In the Quik! Forms Engine assign your Callback URL to the SignCallBackURL property.
  4. OPTIONAL: Call the Quik! web service to retrieve the DocuSign EnvelopeID using the QFVUNID (unique form transaction ID)

...

When you build your web page to receive the EnvelopeID you'll need to respond to the form in JSON format. The format is as follows:
"{"StatusCode":"0","StatusMessage":"Quik request to CallBack URL successful."}" 
The StatusCode of 0 tells the form that the event was successful, any other code is a failure. The status message can be anything you want to display to the user.

Note: If StatusCode is "0", the form will display whatever is provided in a "Message" property of the callback response, or a default message of: "Your form has been submitted for signature. Each recipient will receive an email to begin the signature process. Check your email for signature updates."

If StatusCode is not "0" (indicating a failure), the form will display whatever is provided in a "StatusMessage" property of the callback response, or a default message of: "There was no message response from the CallBack URL. Plase contact an administrator."

Hosted Callback Endpoint

In certain cases you may want to kick off DocuSign without doing your own integration with DocuSign (i.e. to check the status of an envelope or to download signed documents). If you don't need to do anything with the DocuSign EnvelopeID that the Callback method returns then you may want to use our hosted endpoint for the callback method. Our hosted URL will simply return a message that the DocuSign envelope has been started. Use this URL at your discretion. 

...