Dart

DocuSign Add One Document to a Draft Envelope

See more DocuSign Examples

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

import 'package:chilkat/chilkat.dart';

void main() {
  // This example assumes the Chilkat API to have been previously unlocked.
  // See Global Unlock Sample for sample code.

  final http = CkHttp();

  // Load a previously obtained OAuth2 access token.
  final jsonToken = CkJsonObject();
  try {
    jsonToken.loadFile('qa_data/tokens/docusign.json');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

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

  final bd1 = CkBinData();
  bd1.loadFile('qa_data/pdf/project_xyz.pdf');

  final json = CkJsonObject();
  json.updateString('documents[0].documentId', '1');
  json.updateString('documents[0].name', 'project_xyz.pdf');
  json.updateString('documents[0].pages', '1');
  json.updateString('documents[0].documentBase64', bd1.getEncoded('base64'));

  final sbJson = CkStringBuilder();
  json.emitCompact = false;
  json.emitSb(sbJson);

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

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

  final url = 'https://demo.docusign.net/restapi/v2.1/accounts/{\$accountId}/envelopes/{\$envelopeId}/documents';
  final resp = CkHttpResponse();
  try {
    http.httpSb('PUT', url, sbJson, 'utf-8', 'application/json', resp);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  final jResp = CkJsonObject();
  jResp.load(resp.bodyStr);
  jResp.emitCompact = 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).
  final respStatusCode = resp.statusCode;
  print('Response Status Code = $respStatusCode');
  if (respStatusCode >= 400) {
    print('Response Header:');
    print(resp.header);
    print('Failed.');
    return;
  }

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

  var documentId = '';
  var documentIdGuid = '';
  var name = '';
  var vType = '';
  var uri = '';
  var order = '';
  var containsPdfFormFields = '';
  var templateRequired = '';
  var authoritativeCopy = '';

  final envelopeId = jResp.stringOf('envelopeId');
  var i = 0;
  final countI = jResp.sizeOfArray('envelopeDocuments');
  while (i < countI) {
    jResp.i = i;
    documentId = jResp.stringOf('envelopeDocuments[i].documentId');
    documentIdGuid = jResp.stringOf('envelopeDocuments[i].documentIdGuid');
    name = jResp.stringOf('envelopeDocuments[i].name');
    vType = jResp.stringOf('envelopeDocuments[i].type');
    uri = jResp.stringOf('envelopeDocuments[i].uri');
    order = jResp.stringOf('envelopeDocuments[i].order');
    containsPdfFormFields = jResp.stringOf('envelopeDocuments[i].containsPdfFormFields');
    templateRequired = jResp.stringOf('envelopeDocuments[i].templateRequired');
    authoritativeCopy = jResp.stringOf('envelopeDocuments[i].authoritativeCopy');
    i++;
  }
}