Lua

DocuSign: Requesting a Signature via Email (Remote Signing)

See more DocuSign Examples

This code example demonstrates the simplest and quickest workflow for requesting a signature for a document via email. The email will contain a signing link the recipient can use to electronically sign a document from their mobile or desktop computer. 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()

-- Implements the following CURL command:

-- curl --request POST https://demo.docusign.net/restapi/v2.1/accounts/${accountId}/envelopes \
--      --header "Authorization: Bearer ${accessToken}" \
--      --header "Content-Type: application/json" \
--      --data '{
--     "emailSubject": "Please sign this document",
--     "documents": [
--         {
--             "documentBase64": "JVBERi0xLjMKMyAwIG9iag ... dGFydHhyZWYKNjk5CiUlRU9GCg==",
--             "name": "Lorem Ipsum",
--             "fileExtension": "pdf",
--             "documentId": "1"
--         }
--     ],
--     "recipients": {
--         "signers": [
--             {
--                 "email": "joe_sample@example.com",
--                 "name": "Joe Sample",
--                 "recipientId": "1",
--                 "routingOrder": "1",
--                 "tabs": {
--                     "signHereTabs": [
--                         {
--                             "documentId": "1", "pageNumber": "1",
--                             "recipientId": "1", "tabLabel": "SignHereTab",
--                             "xPosition": "195", "yPosition": "147"
--                         }
--                     ]
--                 }
--             }
--         ]
--     },
--     "status": "sent"
-- }'

-- Use this online tool to generate code from sample JSON:
-- Generate Code to Create JSON

-- The following JSON is sent in the request body.

-- {
--   "emailSubject": "Please sign this document",
--   "documents": [
--     {
--       "documentBase64": "JVBERi0xLjMKMyAwIG9iag ... dGFydHhyZWYKNjk5CiUlRU9GCg==",
--       "name": "Lorem Ipsum",
--       "fileExtension": "pdf",
--       "documentId": "1"
--     }
--   ],
--   "recipients": {
--     "signers": [
--       {
--         "email": "joe_sample@example.com",
--         "name": "Joe Sample",
--         "recipientId": "1",
--         "routingOrder": "1",
--         "tabs": {
--           "signHereTabs": [
--             {
--               "documentId": "1",
--               "pageNumber": "1",
--               "recipientId": "1",
--               "tabLabel": "SignHereTab",
--               "xPosition": "195",
--               "yPosition": "147"
--             }
--           ]
--         }
--       }
--     ]
--   },
--   "status": "sent"
-- }

-- Load a PDF to be signed.
local pdfData = chilkat.BinData.new()
local success = pdfData:load_file("qa_data/pdf/helloWorld.pdf")
if not success then
    print("Failed to load local PDF file.")
    return
end

local json = chilkat.JsonObject.new()
json:update_string("emailSubject", "Please sign this document")
json:update_string("documents[0].documentBase64", pdfData:get_encoded("base64"))
json:update_string("documents[0].name", "Lorem Ipsum")
json:update_string("documents[0].fileExtension", "pdf")
json:update_string("documents[0].documentId", "1")
json:update_string("recipients.signers[0].email", "joe_sample@example.com")
json:update_string("recipients.signers[0].name", "Joe Sample")
json:update_string("recipients.signers[0].recipientId", "1")
json:update_string("recipients.signers[0].routingOrder", "1")
json:update_string("recipients.signers[0].tabs.signHereTabs[0].documentId", "1")
json:update_string("recipients.signers[0].tabs.signHereTabs[0].pageNumber", "1")
json:update_string("recipients.signers[0].tabs.signHereTabs[0].recipientId", "1")
json:update_string("recipients.signers[0].tabs.signHereTabs[0].tabLabel", "SignHereTab")
json:update_string("recipients.signers[0].tabs.signHereTabs[0].xPosition", "195")
json:update_string("recipients.signers[0].tabs.signHereTabs[0].yPosition", "147")
json:update_string("status", "sent")

-- Get our previously obtained OAuth2 access token, which should contain JSON like this:
-- {
--   "access_token": "eyJ0eXA....YQyig",
--   "token_type": "Bearer",
--   "refresh_token": "eyJ0eXA....auE3eHKg",
--   "expires_in": 28800
-- }

local jsonToken = chilkat.JsonObject.new()
success = jsonToken:load_file("qa_data/tokens/docusign.json")

local sbAuth = chilkat.StringBuilder.new()
sbAuth:append("Bearer ")
sbAuth:append(jsonToken:string_of("access_token"))

http:set_request_header("Authorization", sbAuth:get_as_string())
http:set_request_header("Content-Type", "application/json")

-- Don't forget to modify this line to use your account ID
local resp = chilkat.HttpResponse.new()
success = http:http_json("POST", "https://demo.docusign.net/restapi/v2.1/accounts/${accountId}/envelopes", json, "application/json", resp)
if not success then
    print(http.last_error_text)
    return
end

local sbResponseBody = chilkat.StringBuilder.new()
resp:get_body_sb(sbResponseBody)
local jResp = chilkat.JsonObject.new()
jResp:load_sb(sbResponseBody)
jResp.emit_compact = false

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

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": "d51cfdab-22ed-4832-bf68-446c44077ffc",
--   "uri": "/envelopes/d51cfdab-22ed-4832-bf68-446c44077ffc",
--   "statusDateTime": "2018-04-17T16:31:51.8830000Z",
--   "status": "sent"
-- }

-- 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 envelopeId = jResp:string_of("envelopeId")
local uri = jResp:string_of("uri")
local statusDateTime = jResp:string_of("statusDateTime")
local status = jResp:string_of("status")