AutoIt

DocuSign Add One Document to a Draft Envelope

See more DocuSign Examples

Demonstrates how to add one document to a DocuSign draft envelope. AutoIt

Local $bSuccess = False

; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.

$oHttp = ObjCreate("Chilkat.Http")

; Load a previously obtained OAuth2 access token.
$oJsonToken = ObjCreate("Chilkat.JsonObject")
$bSuccess = $oJsonToken.LoadFile("qa_data/tokens/docusign.json")
If ($bSuccess = False) Then
    ConsoleWrite($oJsonToken.LastErrorText & @CRLF)
    Exit
EndIf

; Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
$oHttp.AuthToken = $oJsonToken.StringOf("access_token")

; Send the following request.
; Make sure to use your own account ID (obtained from Get Docusign User Account Information)

; PUT https://demo.docusign.net/restapi/v2.1/accounts/<account ID>/envelopes/<envelope ID>/documents HTTP/1.1
; Expect: 100-continue
; Accept: application/json
; Cache-Control: no-cache
; Authorization: Bearer eyJ0eX...
; Content-Length: ...
; Content-Type: application/json
; 
; {
; 	"documents": [
; 		{
; 		"documentId": "1",
; 		"name": "project_xyz.pdf",
; 		"pages": "1",
; 		"documentBase64": "<insert base64 content here>"
; 		}
; 	]
; }

$oBd1 = ObjCreate("Chilkat.BinData")
$bSuccess = $oBd1.LoadFile("qa_data/pdf/project_xyz.pdf")

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("documents[0].documentId","1")
$oJson.UpdateString("documents[0].name","project_xyz.pdf")
$oJson.UpdateString("documents[0].pages","1")
$oJson.UpdateString("documents[0].documentBase64",$oBd1.GetEncoded("base64"))

$oSbJson = ObjCreate("Chilkat.StringBuilder")
$oJson.EmitCompact = False
$oJson.EmitSb($oSbJson)

$oHttp.SetRequestHeader "Expect","100-continue"
$oHttp.SetRequestHeader "Cache-Control","no-cache"
$oHttp.SetRequestHeader "Accept","application/json"

; Use your own account ID here.
$oHttp.SetUrlVar("accountId","7f3f65ed-5e87-418d-94c1-92499ddc8252")
; Use the envelope ID returned by DocuSign when creating the draft envelope).
$oHttp.SetUrlVar("envelopeId","cee4191c-f94e-4089-9d7c-8033685cbc1a")

Local $sUrl = "https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}/documents"
$oResp = ObjCreate("Chilkat.HttpResponse")
$bSuccess = $oHttp.HttpSb("PUT",$sUrl,$oSbJson,"utf-8","application/json",$oResp)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.Load($oResp.BodyStr)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

; If you get a 401 response status code, it's likely you need to refresh the DocuSign OAuth2 token).
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
EndIf

; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)

; {
;   "envelopeId": "da9fb811-e6a4-48c0-a9fb-81ed18b989af",
;   "envelopeDocuments": [
;     {
;       "documentId": "1",
;       "documentIdGuid": "38e919fc-0a77-4b0c-9da0-e3530f4e6fc7",
;       "name": "project_xyz.pdf",
;       "type": "content",
;       "uri": "/envelopes/da9fb811-e6a4-48c0-a9fb-81ed18b989af/documents/1",
;       "order": "3",
;       "containsPdfFormFields": "false",
;       "templateRequired": "false",
;       "authoritativeCopy": "false"
;     }
;   ]
; }

; Sample code for parsing the JSON response...
; Use the following online tool to generate parsing code from sample JSON:
; Generate Parsing Code from JSON

Local $sDocumentId
Local $sDocumentIdGuid
Local $sName
Local $sV_type
Local $sUri
Local $sOrder
Local $sContainsPdfFormFields
Local $sTemplateRequired
Local $sAuthoritativeCopy

Local $sEnvelopeId = $oJResp.StringOf("envelopeId")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("envelopeDocuments")
While $i < $iCount_i
    $oJResp.I = $i
    $sDocumentId = $oJResp.StringOf("envelopeDocuments[i].documentId")
    $sDocumentIdGuid = $oJResp.StringOf("envelopeDocuments[i].documentIdGuid")
    $sName = $oJResp.StringOf("envelopeDocuments[i].name")
    $sV_type = $oJResp.StringOf("envelopeDocuments[i].type")
    $sUri = $oJResp.StringOf("envelopeDocuments[i].uri")
    $sOrder = $oJResp.StringOf("envelopeDocuments[i].order")
    $sContainsPdfFormFields = $oJResp.StringOf("envelopeDocuments[i].containsPdfFormFields")
    $sTemplateRequired = $oJResp.StringOf("envelopeDocuments[i].templateRequired")
    $sAuthoritativeCopy = $oJResp.StringOf("envelopeDocuments[i].authoritativeCopy")
    $i = $i + 1
Wend