(Delphi DLL) DocuSign Add One Document to a Draft Envelope

See more DocuSign Examples

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

For more information, see https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopedocuments/updatelist/

Chilkat for Delphi Downloads Chilkat non-ActiveX DLL for Delphi Chilkat ActiveX DLL for Delphi * The examples here use the non-ActiveX DLL.

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Http, BinData, StringBuilder, HttpResponse, JsonObject;

...

procedure TForm1.Button1Click(Sender: TObject);
var
http: HCkHttp;
jsonToken: HCkJsonObject;
success: Boolean;
bd1: HCkBinData;
json: HCkJsonObject;
sbJson: HCkStringBuilder;
url: PWideChar;
resp: HCkHttpResponse;
jResp: HCkJsonObject;
respStatusCode: Integer;
documentId: PWideChar;
documentIdGuid: PWideChar;
name: PWideChar;
v_type: PWideChar;
uri: PWideChar;
order: PWideChar;
containsPdfFormFields: PWideChar;
templateRequired: PWideChar;
authoritativeCopy: PWideChar;
envelopeId: PWideChar;
i: Integer;
count_i: Integer;

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

http := CkHttp_Create();

// Load a previously obtained OAuth2 access token.
jsonToken := CkJsonObject_Create();
success := CkJsonObject_LoadFile(jsonToken,'qa_data/tokens/docusign.json');
if (success = False) then
  begin
    Memo1.Lines.Add(CkJsonObject__lastErrorText(jsonToken));
    Exit;
  end;

// Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
CkHttp_putAuthToken(http,CkJsonObject__stringOf(jsonToken,'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>"
// 		}
// 	]
// }

bd1 := CkBinData_Create();
success := CkBinData_LoadFile(bd1,'qa_data/pdf/project_xyz.pdf');

json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'documents[0].documentId','1');
CkJsonObject_UpdateString(json,'documents[0].name','project_xyz.pdf');
CkJsonObject_UpdateString(json,'documents[0].pages','1');
CkJsonObject_UpdateString(json,'documents[0].documentBase64',CkBinData__getEncoded(bd1,'base64'));

sbJson := CkStringBuilder_Create();
CkJsonObject_putEmitCompact(json,False);
CkJsonObject_EmitSb(json,sbJson);

CkHttp_SetRequestHeader(http,'Expect','100-continue');
CkHttp_SetRequestHeader(http,'Cache-Control','no-cache');
CkHttp_SetRequestHeader(http,'Accept','application/json');

// Use your own account ID here.
CkHttp_SetUrlVar(http,'accountId','7f3f65ed-5e87-418d-94c1-92499ddc8252');
// Use the envelope ID returned by DocuSign when creating the draft envelope).
CkHttp_SetUrlVar(http,'envelopeId','0b437b95-cc50-475f-8dec-65bae9f27d09');

url := 'https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}/documents';
resp := CkHttp_PTextSb(http,'PUT',url,sbJson,'utf-8','application/json',False,False);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

jResp := CkJsonObject_Create();
CkJsonObject_Load(jResp,CkHttpResponse__bodyStr(resp));
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

// If you get a 401 response status code, it's likely you need to refresh the DocuSign OAuth2 token).
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttpResponse__header(resp));
    Memo1.Lines.Add('Failed.');
    CkHttpResponse_Dispose(resp);
    Exit;
  end;
CkHttpResponse_Dispose(resp);

// 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

envelopeId := CkJsonObject__stringOf(jResp,'envelopeId');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'envelopeDocuments');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    documentId := CkJsonObject__stringOf(jResp,'envelopeDocuments[i].documentId');
    documentIdGuid := CkJsonObject__stringOf(jResp,'envelopeDocuments[i].documentIdGuid');
    name := CkJsonObject__stringOf(jResp,'envelopeDocuments[i].name');
    v_type := CkJsonObject__stringOf(jResp,'envelopeDocuments[i].type');
    uri := CkJsonObject__stringOf(jResp,'envelopeDocuments[i].uri');
    order := CkJsonObject__stringOf(jResp,'envelopeDocuments[i].order');
    containsPdfFormFields := CkJsonObject__stringOf(jResp,'envelopeDocuments[i].containsPdfFormFields');
    templateRequired := CkJsonObject__stringOf(jResp,'envelopeDocuments[i].templateRequired');
    authoritativeCopy := CkJsonObject__stringOf(jResp,'envelopeDocuments[i].authoritativeCopy');
    i := i + 1;
  end;

CkHttp_Dispose(http);
CkJsonObject_Dispose(jsonToken);
CkBinData_Dispose(bd1);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbJson);
CkJsonObject_Dispose(jResp);

end;