Tcl

Yousign Procedure Creation Basic Mode Upload File

See more Yousign Examples

Demonstrates the 1st step of Yousign procedure creation, which is to upload a PDF file. Tcl

load ./chilkat.dll

set success 0

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

set http [new_CkHttp]

# Implements the following CURL command:

# curl --location --request POST 'https://staging-api.yousign.com/files' \
# --header 'Authorization: Bearer YOUR_API_KEY' \
# --header 'Content-Type: application/json' \
# --data-raw '{
#     "name": "The best name for my file.pdf",
#     "content": "JVBERi0..." }'

# Load a PDF file to be uploaded.
set pdfData [new_CkBinData]

set success [CkBinData_LoadFile $pdfData "qa_data/pdf/helloWorld.pdf"]
if {$success == 0} then {
    puts "Failed to load PDF local file."
    delete_CkHttp $http
    delete_CkBinData $pdfData
    exit
}

# Use the following online tool to generate HTTP code from a CURL command
# Convert a cURL Command to HTTP Source Code

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

# The following JSON is sent in the request body.

# {
#   "name": "The best name for my file.pdf",
#   "content": "JVBERi0..."
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "name" "helloWorld.pdf"
CkJsonObject_UpdateString $json "content" [CkBinData_getEncoded $pdfData "base64"]

# Adds the "Authorization: Bearer YOUR_API_KEY" header.
CkHttp_put_AuthToken $http "YOUR_API_KEY"

set resp [new_CkHttpResponse]

set success [CkHttp_HttpJson $http "POST" "https://staging-api.yousign.com/files" $json "application/json" $resp]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkBinData $pdfData
    delete_CkJsonObject $json
    delete_CkHttpResponse $resp
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttp $http
    delete_CkBinData $pdfData
    delete_CkJsonObject $json
    delete_CkHttpResponse $resp
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "id": "/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
#   "name": "The best name for my file.pdf",
#   "type": "signable",
#   "contentType": "application/pdf",
#   "description": null,
#   "createdAt": "2018-12-01T11:36:20+01:00",
#   "updatedAt": "2018-12-01T11:36:20+01:00",
#   "sha256": "bb57ae2b2ca6ad0133a699350d1a6f6c8cdfde3cf872cf526585d306e4675cc2",
#   "metadata": [
#   ],
#   "workspace": "/workspaces/XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
#   "creator": null,
#   "protected": false,
#   "position": 0,
#   "parent": null
# }

# Sample code for parsing the JSON response...
# Use the following online tool to generate parsing code from sample JSON:
# Generate Parsing Code from JSON

set id [CkJsonObject_stringOf $jResp "id"]
set name [CkJsonObject_stringOf $jResp "name"]
set v_type [CkJsonObject_stringOf $jResp "type"]
set contentType [CkJsonObject_stringOf $jResp "contentType"]
set description [CkJsonObject_stringOf $jResp "description"]
set createdAt [CkJsonObject_stringOf $jResp "createdAt"]
set updatedAt [CkJsonObject_stringOf $jResp "updatedAt"]
set sha256 [CkJsonObject_stringOf $jResp "sha256"]
set workspace [CkJsonObject_stringOf $jResp "workspace"]
set creator [CkJsonObject_stringOf $jResp "creator"]
set v_protected [CkJsonObject_BoolOf $jResp "protected"]
set position [CkJsonObject_IntOf $jResp "position"]
set parent [CkJsonObject_stringOf $jResp "parent"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "metadata"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkBinData $pdfData
delete_CkJsonObject $json
delete_CkHttpResponse $resp
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp