Ruby

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. Ruby

require 'chilkat'

success = false

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

http = Chilkat::CkHttp.new()

# 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.
pdfData = Chilkat::CkBinData.new()
success = pdfData.LoadFile("qa_data/pdf/helloWorld.pdf")
if (success == false)
    print "Failed to load PDF local file." + "\n";
    exit
end

# 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..."
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("name","helloWorld.pdf")
json.UpdateString("content",pdfData.getEncoded("base64"))

# Adds the "Authorization: Bearer YOUR_API_KEY" header.
http.put_AuthToken("YOUR_API_KEY")

resp = Chilkat::CkHttpResponse.new()
success = http.HttpJson("POST","https://staging-api.yousign.com/files",json,"application/json",resp)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";
    exit
end

# 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

id = jResp.stringOf("id")
name = jResp.stringOf("name")
v_type = jResp.stringOf("type")
contentType = jResp.stringOf("contentType")
description = jResp.stringOf("description")
createdAt = jResp.stringOf("createdAt")
updatedAt = jResp.stringOf("updatedAt")
sha256 = jResp.stringOf("sha256")
workspace = jResp.stringOf("workspace")
creator = jResp.stringOf("creator")
v_protected = jResp.BoolOf("protected")
position = jResp.IntOf("position")
parent = jResp.stringOf("parent")
i = 0
count_i = jResp.SizeOfArray("metadata")
while i < count_i
    jResp.put_I(i)
    i = i + 1
end