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 – In order to set up a token, you can do it in a web site or consuming a REST API:
    1. Web site: https://qcc.quikforms.com/QFE/ESignSetup.aspx
      1. Log in and go to ESignSetup page.
      2. Under Docusign box, provide Docusign's username and password, the Docusign environment associated to the account, and a CustomerUserID (alias for the token. This is provided later in the QFE configuration as the AuthUserID property of the ESignTypeDocusign object. We take that alias and find the associated token)
      3. Click on Generate
      4. The new token and any other existing tokens are displayed in the grid below 
    2. REST API: https://websvcs.quikforms.com/rest/ESignatureesignature/swagger/index.html (POST)
      1. Send over a JSON like the following: {
        "DocusignUsername": "string",
        "DocusignPassword": "string",
        "SignEnviromentID": 0,
        "CustomerUserID": "string"
        }
      2. The request must be authenticated via token
  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 within the ESignTypeDocusign object.

...

  1. Use the following settings in the Quik! Forms Engine:
    1. ESignType set to a new instance of ESignTypeDocusign property
      1. Set the SignEnvironmentID.
      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 (i.e. Step 6 in the graphic above). 

        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:  https://websvcs.quikforms.com/rest/ESignatureesignature/docusign/sign 

      3. Provide the CustomerUserID of the desired token in the AuthUserID property
    2. SignSubmitCombined set 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.
    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! (https://websvcs.quikforms.com/rest/ESignatureesignature/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, CustomerUserID and Docusign environment
    2. Quik! uses the provided information 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. If customer has entered custom JavaScript using the ESignVendorSuccessJavaScript property, a JS command will run after a successful transaction.
  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.

...