Versions Compared

Old Version 7

changes.mady.by.user Austin Logie (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user Ben Cortez

Saved on

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 http://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 a Docusign OAuth token with Quik! to call the Docusign API on behalf of the customer. An OAuthToken can be established via web service or manually by request. This 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).

Process Flow 

...

How To Use the Callback Method

You must set up the following components to use the Callback method (NOTE: All web service URLs seen in this documentation are the most recent versions, regardless of whether the URL contains 5400 or 5500):

...

  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)

  1. Create a Docusign OAuth token within the Quik! App.

    1. Detailed steps: Docusign Authentication (Create OAuth Tokens)

  2. Configure an Execute HTML request containing Docusign token and environment details for the ESignType.

  3. Set up a URL on your application or server to receive the DocuSign EnvelopeID.

  4. In the Quik! Forms Engine assign your Callback URL to the SignCallBackURL property

...

Callback Web Service URL:

...

  1. within the ESignType object.

Detailed Method Steps

Here are the basic setup steps for this method:

...

  1. Use the following settings in the Quik! Forms Engine:

...

    1. Configure an Execute HTML request and configure the ESignType for Docusign:

      1. Code Block
        {
    "HostFormOnQuik": true,
    "QuikFormID": "12",
    "PrintEditablePDF": true,
    "FormFields": [
        {
            "FieldName": "1own.FName",
            "FieldValue": "John"
        },
        {
            "FieldName": "1own.LName",
            "FieldValue": "Doe"
        },
        {
            "FieldName": "1own.H.Email",
            "FieldValue": "JohnDoe@test.com"
        }
    ],
    "ESignType": {
        "Type": "docusign",
        "AuthUserID": "<YourAuthUserID>",
        "SignCallBackURL": "<YourCallbackURL>",
        "SignEnvironmentID": 2
    }
}

      2. ESignType Details:

        1. Set the SignEnvironmentID. This value can be obtained by calling the GET /docusign/oauthtokens endpoint listed on this page: Swagger: REST ESignature API

        2. Set the SignCallBackURL, which is a customer-defined URL for the Quik! Form to post the EnvelopeID to so customer's system knows the transaction is complete

...

        1. .

          1. *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:

...

          1.   https://websvcs.quikforms.com/

...

          1. rest/

...

          1. esignature/

...

  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)

...

          1. docusign/sign 

        2. In the AuthUserID property, enter the Connection Name of the desired token. You can find this value in the Quik! App under DocuSign Properties, where it matches the name you assigned to your DocuSign connection.

      2. For more Docusign properties, visit: DocuSign Properties

    2. Optional Configuration: Configuring the Submit Button

      1. You can set SignSubmitCombined to TRUE to make the e-sign SEND button event first invoke the Submit event and Submit URL before starting the signature process. The Submit validation for required fields will also be triggered but a failed validation will not stop the signature process using the default Submit JavaScript.

      2. Alternatively the customer can set the SignSendJavascript property to override the default

...

      1. JavaScriptassociated to the e-sign SEND button in order to use the customer's own

...

      1. JavaScript.

  2. 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! (https://websvcs.quikforms.com/

...

    1. rest/

...

    1. esignature/

...

    1. docusign/sign )

  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

...

    1. , CustomerUserID and Docusign environment) 

    2. Quik! uses the

...

    1. provided information to lookup the Customer's OAuthToken stored by Quik! and then calls the DocuSign REST web service to start the envelope

  2. 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.

  3. Quik! responds to user's Quik! Form (HTML window) with the EnvelopeID in JSON format.

  4. 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

...

    1. . If customer has entered custom JavaScript using the ESignVendorSuccessJavaScript property, a JS command will run after a successful transaction.

  2. Customer independently downloads the envelope and documents from DocuSign

  3. The customer will be able to access/sign the form by logging into their DocuSign account.

Setting Up OAuth Tokens

In order for users to sign, the Quik! Master Account must be setup with an OAuth Token for the user/customer's DocuSign account (partners will need to set up OAuth Tokens for each of their customer accounts). You’ll need to set up the OAuth Token using our web service (API Ref Guide): https://efficienttech.atlassian.net/wiki/pages/viewpage.action?pageId=34144315

Partners

Partners who offer Quik! to multiple customers will need to address how each of their customers will set up OAuth tokens on their Quik! accounts. The ideal solution is for the partner to build a user interface that asks the customer to enter their DocuSign credentials which you pass to our CreateOAuth2Token web service to establish the token. Quik! does not store the customer credentials, just the token which never expires. This enables customers to change their DocuSign password without affecting their integration with Quik! and you don’t have to manage their credentials, per se. In your user interface you need to ask the user to identify their DocuSign environment (NA1, NA2, Demo, etc.). The most reliable way to determine the DocuSign environment is for the user to login to their DocuSign account and to look at the DocuSign URL after they log in – if the URL begins with “www” then NA1, if “NA2” then NA2, etc. Most DocuSign users are on NA2.

For an example of how Quik! has built a similar user experience, please see this page (you’ll be prompted to log in – then go to the ESign Setup page): https://qcc.quikforms.com/QFLM/ESignSetup.aspx 

...

REST ESignature API

Callback JSON Format 

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:

Code Block

...

{
"StatusCode": 0 ,
"StatusMessage: "

...

200 (ok)",
"

...

Message":

...

 "Your form has been submitted for signature. Each recipient will receive an email to begin the signature process. Check your email for signature updates."
}

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. 

Hosted Callback Endpoint https://websvcs.quikforms.com/rest/ESignature/callbackurl

Legacy Method

NOTE: SOAP are legacy web services originally developed for the Quik! APIs. At this time, they are deprecated and no longer in use. This guide is here for documentation purposes only. 

Enabling CallBack method in QuikFormsEngine SOAP web service 5500 version

Code Block
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationHeader xmlns="https://websvcs.quikforms.com

...

/quikformsenginews/">
      <CustomerID>YOUR CUSTOMER ID</CustomerID>
      <UserName>YOUR USERNAME</UserName>
      <Password>YOUR PASSWORD</Password>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <Execute xmlns="https://websvcs.quikforms.com/quikformsenginews/">
		<QFESettings>
	        <HostFormOnQuik>true</HostFormOnQuik>
	        <QuikFormID>1</QuikFormID>
	        <ESignType xsi:type="ESignTypeDocusign">
	            <SignCallBackURL>https://google.com</SignCallBackURL>
	            <SignEnvironmentID>2</SignEnvironmentID>
	        </ESignType>
       </QFESettings>
    </Execute>
  </soap:Body>
</soap:Envelope>

Notes

  1. With xsi:type="ESignTypeDocusign" in ESignType tag you are telling the web service to use Docusign. All Docusign properties need to be configured within this tag

  2. SignCallBackURL tag tells the web service to enable the CallBack model.