Chilkat Online Tools

PureBasic / DocuSign Click API / 1. Create an Envelope

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

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

    ; The following JSON is sent in the request body.

    ; {
    ;   "documents": [
    ;     {
    ;       "documentBase64": "{{documentBase64}}",
    ;       "documentId": 123,
    ;       "fileExtension": "pdf",
    ;       "name": "document"
    ;     }
    ;   ],
    ;   "emailSubject": "Simple Signing Example",
    ;   "recipients": {
    ;     "signers": [
    ;       {
    ;         "email": "{{email}}",
    ;         "name": "{{name}}",
    ;         "recipientId": "{{recipientId}}"
    ;       }
    ;     ]
    ;   },
    ;   "status": "sent"
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"documents[0].documentBase64","{{documentBase64}}")
    CkJsonObject::ckUpdateInt(json,"documents[0].documentId",123)
    CkJsonObject::ckUpdateString(json,"documents[0].fileExtension","pdf")
    CkJsonObject::ckUpdateString(json,"documents[0].name","document")
    CkJsonObject::ckUpdateString(json,"emailSubject","Simple Signing Example")
    CkJsonObject::ckUpdateString(json,"recipients.signers[0].email","{{email}}")
    CkJsonObject::ckUpdateString(json,"recipients.signers[0].name","{{name}}")
    CkJsonObject::ckUpdateString(json,"recipients.signers[0].recipientId","{{recipientId}}")
    CkJsonObject::ckUpdateString(json,"status","sent")

    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
    ; Adds the "Authorization: Bearer {{accessToken}}" header.
    CkHttp::setCkAuthToken(http, "{{accessToken}}")

    resp.i = CkHttp::ckPostJson3(http,"https://domain.com/{{apiVersion}}/accounts/{{accountId}}/envelopes","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "documents": [
    {
      "documentBase64": {{document}},
      "documentId": {{documentId}},
      "fileExtension": "pdf",
      "name": "document"
    }
  ],
  "emailSubject": "Simple Signing Example",
  "recipients": {
    "signers": [
      {
        "email": {{user1}},
        "name": {{user1_name}},
        "recipientId": "{{recipientId}}"
      }
    ]
  },
  "status": "sent"
}'
https://domain.com/{{apiVersion}}/accounts/{{accountId}}/envelopes

Postman Collection Item JSON

{
  "name": "1. Create an Envelope",
  "event": [
    {
      "listen": "test",
      "script": {
        "type": "text/javascript",
        "exec": [
          "var jsonData = JSON.parse(responseBody);",
          "postman.setEnvironmentVariable(\"envelopeId\", jsonData.envelopeId);"
        ]
      }
    }
  ],
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"documents\": [\n    {\n      \"documentBase64\": {{document}},\n      \"documentId\": {{documentId}},\n      \"fileExtension\": \"pdf\",\n      \"name\": \"document\"\n    }\n  ],\n  \"emailSubject\": \"Simple Signing Example\",\n  \"recipients\": {\n    \"signers\": [\n      {\n        \"email\": {{user1}},\n        \"name\": {{user1_name}},\n        \"recipientId\": \"{{recipientId}}\"\n      }\n    ]\n  },\n  \"status\": \"sent\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/{{apiVersion}}/accounts/{{accountId}}/envelopes",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "{{apiVersion}}",
        "accounts",
        "{{accountId}}",
        "envelopes"
      ]
    },
    "description": "This example is a very basic example of creating an evenlope with a document and a single signer. This evenlope does not specify a tab."
  },
  "response": [
  ]
}