Lua

DocuSign Add One Document to a Draft Envelope

See more DocuSign Examples

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

local chilkat = require("chilkat")

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

local http = chilkat.Http.new()

-- Load a previously obtained OAuth2 access token.
local jsonToken = chilkat.JsonObject.new()
local success = jsonToken:load_file("qa_data/tokens/docusign.json")
if not success then
    print(jsonToken.last_error_text)
    return
end

-- Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
http.auth_token = jsonToken:string_of("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>"
--         }
--     ]
-- }

local bd1 = chilkat.BinData.new()
success = bd1:load_file("qa_data/pdf/project_xyz.pdf")

local json = chilkat.JsonObject.new()
json:update_string("documents[0].documentId", "1")
json:update_string("documents[0].name", "project_xyz.pdf")
json:update_string("documents[0].pages", "1")
json:update_string("documents[0].documentBase64", bd1:get_encoded("base64"))

local sbJson = chilkat.StringBuilder.new()
json.emit_compact = false
json:emit_sb(sbJson)

http:set_request_header("Expect", "100-continue")
http:set_request_header("Cache-Control", "no-cache")
http:set_request_header("Accept", "application/json")

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

local url = "https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}/documents"
local resp = chilkat.HttpResponse.new()
success = http:http_sb("PUT", url, sbJson, "utf-8", "application/json", resp)
if not success then
    print(http.last_error_text)
    return
end

local jResp = chilkat.JsonObject.new()
jResp:load(resp.body_str)
jResp.emit_compact = false

print("Response Body:")
print(jResp:emit())

-- If you get a 401 response status code, it's likely you need to refresh the DocuSign OAuth2 token).
local respStatusCode = resp.status_code
print("Response Status Code = " .. respStatusCode)
if respStatusCode >= 400 then
    print("Response Header:")
    print(resp.header)
    print("Failed.")
    return
end

-- 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 documentId = ""
local documentIdGuid = ""
local name = ""
local v_type = ""
local uri = ""
local order = ""
local containsPdfFormFields = ""
local templateRequired = ""
local authoritativeCopy = ""

local envelopeId = jResp:string_of("envelopeId")
local i = 0
local count_i = jResp:size_of_array("envelopeDocuments")
while i < count_i do
    jResp.i = i
    documentId = jResp:string_of("envelopeDocuments[i].documentId")
    documentIdGuid = jResp:string_of("envelopeDocuments[i].documentIdGuid")
    name = jResp:string_of("envelopeDocuments[i].name")
    v_type = jResp:string_of("envelopeDocuments[i].type")
    uri = jResp:string_of("envelopeDocuments[i].uri")
    order = jResp:string_of("envelopeDocuments[i].order")
    containsPdfFormFields = jResp:string_of("envelopeDocuments[i].containsPdfFormFields")
    templateRequired = jResp:string_of("envelopeDocuments[i].templateRequired")
    authoritativeCopy = jResp:string_of("envelopeDocuments[i].authoritativeCopy")
    i = i + 1
end