Xojo Plugin
Xojo Plugin
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.Chilkat Xojo Plugin Downloads
Dim success As Boolean
success = False
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
// 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.
Dim pdfData As New Chilkat.BinData
success = pdfData.LoadFile("qa_data/pdf/helloWorld.pdf")
If (success = False) Then
System.DebugLog("Failed to load PDF local file.")
Return
End If
// 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..."
// }
Dim json As New Chilkat.JsonObject
success = json.UpdateString("name","helloWorld.pdf")
success = json.UpdateString("content",pdfData.GetEncoded("base64"))
// Adds the "Authorization: Bearer YOUR_API_KEY" header.
http.AuthToken = "YOUR_API_KEY"
Dim resp As New Chilkat.HttpResponse
success = http.HttpJson("POST","https://staging-api.yousign.com/files",json,"application/json",resp)
If (success = False) Then
System.DebugLog(http.LastErrorText)
Return
End If
Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())
Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
System.DebugLog("Response Header:")
System.DebugLog(resp.Header)
System.DebugLog("Failed.")
Return
End If
// 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
Dim id As String
id = jResp.StringOf("id")
Dim name As String
name = jResp.StringOf("name")
Dim v_type As String
v_type = jResp.StringOf("type")
Dim contentType As String
contentType = jResp.StringOf("contentType")
Dim description As String
description = jResp.StringOf("description")
Dim createdAt As String
createdAt = jResp.StringOf("createdAt")
Dim updatedAt As String
updatedAt = jResp.StringOf("updatedAt")
Dim sha256 As String
sha256 = jResp.StringOf("sha256")
Dim workspace As String
workspace = jResp.StringOf("workspace")
Dim creator As String
creator = jResp.StringOf("creator")
Dim v_protected As Boolean
v_protected = jResp.BoolOf("protected")
Dim position As Int32
position = jResp.IntOf("position")
Dim parent As String
parent = jResp.StringOf("parent")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("metadata")
While i < count_i
jResp.I = i
i = i + 1
Wend