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  This integration method is mostly be used by optimal for retail or individual customers, or enterprise-level customers who need a streamlined method to start the envelope process (e.g. SalesForce users).

...

How To Use the Callback Method

Using You must set up the following components to use the Callback method will require the minimum following components to be set up(NOTE: Although some web services may include 5400 in their URLs, these are the most recent versions of each):

  1. OAuthToken – Set up a token by request or via web service call (use ApplicationID = 3): (Legacy v5.4) 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)

Callback Web Service URL:

(Legacy v5.4) https://websvcs.quikforms.com/Docusign/ESignWSVersion/5400/ESignWithOAuthToken.asmx

...

NOTE: If the SignCallBackURL is set then the SignURL value, even if set by you, will automatically be set by the Quik! Forms Engine to this URL:(Legacy v5.4) https://websvcs.quikforms.com/Docusign/ESignWSVersion/5400/GetDocusignData.asmx

    1. Set the SignEnvironmentID and set up an OAuthToken for each environment you're actively using.
      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. In step 6, the customer's SignCallBackURL will receive the EnvelopeID and then respond to the form in JSON format with any status message to display or an event to invoke (e.g. redirect the user to a new window, update the form with data, display a message, etc.)
    3. Alternatively the customer can set the SignSendJavascript property to override the default javascript associated to the e-sign SEND button in order to use the customer's own javascript.
  1. The user clicks the "Sign" button, which captures the envelope data needed for signing.
    1. The Sign button event displays the Quik! Form's e-sign popup screen.
    2. User enters relevant envelope data and clicks the SEND button.
    3. The SEND event posts the form data directly to Quik! (Legacy v5.4) (https://websvcs.quikforms.com/DocuSign/ESignWSVersion/5400/GetDocuSignEnvelopeID.aspx)
  2. Quik! starts an envelope with DocuSign
    1. The customer must have previously set up an OAuthToken with Quik! and DocuSign (only once per CustomerID!) using the OAuthToken web service (Legacy v5.4) (https://websvcs.quikforms.com/Docusign/ESignWSVersion/5400/OAuthToken.asmx)
    2. Quik! uses the form's QFVUNID to lookup the Customer's OAuthToken stored by Quik! and then calls the DocuSign REST web service to start the envelope
  3. DocuSign responds with the EnvelopeID
    1. The EnvelopeID is stored with the QFVUNID in the Quik! system for later retrieval by the customer via web service as a backup method for retrieving EnvelopeIDs.
  4. Quik! responds to user's Quik! Form (HTML window) with the EnvelopeID in JSON format.
  5. The user's Quik! Form posts the EnvelopeID to the Customer's SignCallBackURL in JSON format along with any status message returned by the signing process
    1. The HTML form's SEND event does a callback to the SignCallBackURL with the EnvelopeID.
    2. The customer's SignCallBackURL receives the EnvelopeID and should then respond in JSON format to the user's form with a status message, a javascript command to run to initiate the next action or redirects the user to a new page.
  6. Customer independently downloads the envelope and documents from DocuSign
  7. The customer will be able to access/sign the form by logging into their DocuSign account.

...

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.

...