DocuSign API with ColdFusion

Question

UPDATED WITH WORKING SOLUTION

I'm trying to integrate the DocuSign API using ColdFusion and keep running into an issue. I am able to authenticate successfully and retrieve the base URL. However, when trying to create the envelope with a single recipient and document, I get an error stating that the "boundary terminator" is not found in the request (when it clearly is).

I know this questions is similar to another post here but that was from a while ago and was never completely answered.

I first read in the PDF document:

<cffile action="READBINARY" file="Agreement.pdf" variable="docData">
<cfset docData = BinaryEncode(docData,"Base64")>

I then create the envelope definition in XML using the element to include the encoded binary PDF data:

<cfset envelope = "<envelopeDefinition xmlns=""http://www.docusign.com/restapi"">
                <status>Sent</status>
                <emailSubject>eSignature request</emailSubject>
                <emailBlurb>Please sign the document</emailBlurb>
                <recipients>
                    <signers>
                        <signer>
                            <recipientId>1</recipientId>
                            <name>eCS Buyer</name>
                            <email>XXX@XXXX.com</email>
                            <tabs>
                                <signHereTabs>
                                    <signHere>
                                        <documentId>1</documentId>
                                        <pageNumber>3</pageNumber>
                                        <xPosition>10</xPosition>
                                        <yPosition>100</yPosition>
                                    </signHere>
                                </signHereTabs>
                            </tabs>
                        </signer>
                    </signers>
                </recipients>
                <documents>
                    <document>
                        <name>Agreement.pdf</name>
                        <documentId>1</documentId>
                        <fileExtension>pdf</fileExtension>
                        <documentBase64>#docData#</documentBase64>
                    </document>
                </documents>
               </envelopeDefinition>">

Lastly, I POST the information:

<cfhttp url="#baseURL#/envelopes" method="POST" resolveurl="Yes" throwonerror="No">
<cfhttpparam name="X-DocuSign-Authentication" type="HEADER" value="<DocuSignCredentials><Username>#userName#</Username><Password>#password#</Password><IntegratorKey>#integratorKey#</IntegratorKey></DocuSignCredentials>">
<cfhttpparam name="Content-Type" type="HEADER" value="application/xml">
<cfhttpparam name="Accept" type="HEADER" value="application/xml">
<cfhttpparam name="Content-Length" type="HEADER" value="#Len(envelope)#">
<cfhttpparam name="request_body" type="BODY" value="#envelope#">
</cfhttp>

I tried changing the TYPE attribute for the request body to XML and FORMFIELD but is still doesn't work. I even tried changing the envelope to JSON format to no avail.

The error that is generated is:

<errorCode>INVALID_REQUEST_BODY</errorCode><message>The request body is missing or improperly formatted. The XML request does not match the expected format. </message></errorDetails> 

I have been struggling with this for weeks. Any guidance would be GREATLY appreciated.

Answer 1

Most likely an issue with extra CRLF (i.e., extra line breaks). See the answer in this other forum post for an example of what the full request structure should look like: Docusign : Unable to create envelope from document in restapi v2.

UPDATE #1

Looks like your XML request body is missing information about the Document. Try adding a documents element as a child element of envelopeDefinition (i.e., as a peer element to recipients):

<envelopeDefinition xmlns=""http://www.docusign.com/restapi"">
    ...            
    <documents>
        <document>
            <name>Agreement.pdf</name>
            <documentId>1</documentId>
        </document>
    </documents>
    ...
</envelopeDefinition>

Also, make sure the document bytes that your sending in the subsequent part of the request are not encoded.

UPDATE #2

I don't know much about ColdFusion, but this line of your code makes it look like you're (base64) encoding the byte stream that you're including in the Request:

<cfset docData = BinaryEncode(docData,"Base64")>

This could be causing your latest issue, as I don't believe DocuSign will accept an encoded byte stream when it's included in the manner you're currently utilizing.

If you must base64-encode the byte stream, you could add a documentBase64 property under the document element to contain the base64-encoded byte stream. (See page 104 of the DocuSign REST API Guide -- http://www.docusign.com/sites/default/files/REST_API_Guide_v2.pdf.) If you utilized this approach, your request would no longer need to be a 'multipart' request, since the document bytes would be included in the XML portion of the Request Body (not in a subsequent/separate part). Here's an example of what the Request would look like, if the base64-encoded byte stream was included within the documentBase64 element:

POST /restapi/v2/accounts/ACCOUNT_NUMBER/envelopes HTTP/1.1
Host: demo.docusign.net
X-DocuSign-Authentication: {"Username":"SENDER_EMAIL_ADDRESS","Password":"PASSWORD","IntegratorKey":"INT_KEY"}
Content-Type: application/xml

<envelopeDefinition xmlns="http://www.docusign.com/restapi">
    <accountId>ACCOUNT_ID</accountId>
    <status>sent</status>  
    <emailSubject>eSignature request</emailSubject>
    <emailBlurb>Please sign the document</emailBlurb>
    <recipients>
      <signers>
        <signer>
         <email>johnsEmail@outlook.com</email>
         <name>John Doe</name>
         <recipientId>1</recipientId>
         <routingOrder>1</routingOrder>  
         <tabs>
            <signHereTabs>
                <signHere>
                    <documentId>1</documentId>
                    <pageNumber>1</pageNumber>
                    <xPosition>10</xPosition>
                    <yPosition>100</yPosition>
                </signHere>
            </signHereTabs>
        </tabs>
        </signer>
      </signers>
    </recipients>
    <documents>
        <document>
            <name>Agreement.pdf</name>
            <documentId>1</documentId>
            <fileExtension>pdf</fileExtension>
            <documentBase64>BASE64-ENCODED-BYTE-STREAM</documentBase64>
        </document>
    </documents>
</envelopeDefinition>

Since the document bytes are included within the XML portion of the request, the request no longer needs to be multi-part -- simply pass the XML Request body as I've shown above, and that's it.

Answer 2

The error is most likely due to the extra CRLF you have after the document bytes and before your closing boundary --MYBOUNDARY--. You have this:

#docData#

--MYBOUNDARY--

Try changing that to this without that extra CRLF:

#docData#
--MYBOUNDARY--

For reference you can check out the DocuSign API Walkthrough for sending a signature request on a document. Each of the different language versions shows you how the outgoing request body should be formatted.