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).
...
- OAuthToken – Set up a token by request or via web service call (use ApplicationID = 3): https://websvcs.quikforms.com/Docusign/ESignWSVersion/5400/OAuthToken.asmx
- Use ApplicationID = 3 (Quik! Forms Engine application ID)
- 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 for DocuSign production accounts on NA1 (www.docusign.net)
- 2 for DocuSign DEMO accounts (demo.docusign.net)
- 3 for DocuSign production accounts on NA2 (na2.docusign.net)
- 4 for DocuSign production accounts in Europe on EU1 (eu1.docusign.net)
- 5 for DocuSign Preview accounts (preview.docusign.net)
- Set up a URL on your application or server to receive the DocuSign EnvelopeID
- In the Quik! Forms Engine assign your Callback URL to the SignCallBackURL property.
- 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.
...
Hosted Callback Endpoint https://websvcs.quikforms.com/Docusign/CallbackEndPoint/CallBack.aspx
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
- 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
- SignCallBackURL tag tells the web service to enable the CallBack model.