(JavaScript) Yousign Procedure Creation Basic Mode Upload File

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

For more information, see https://dev.yousign.com/?version=latest#0889a9c5-aa1e-4de0-9b35-4d6621b4eb20

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

var success = false;

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

var 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.
var pdfData = new CkBinData();
success = pdfData.LoadFile("qa_data/pdf/helloWorld.pdf");
if (success == false) {
    console.log("Failed to load PDF local file.");
    return;
}

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

var json = new CkJsonObject();
json.UpdateString("name","helloWorld.pdf");
json.UpdateString("content",pdfData.GetEncoded("base64"));

// Adds the "Authorization: Bearer YOUR_API_KEY" header.
http.AuthToken = "YOUR_API_KEY";

var resp = new CkHttpResponse();
success = http.HttpJson("POST","https://staging-api.yousign.com/files",json,"application/json",resp);
if (success == false) {
    console.log(http.LastErrorText);
    return;
}

var sbResponseBody = new CkStringBuilder();
resp.GetBodySb(sbResponseBody);
var jResp = new CkJsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

console.log("Response Body:");
console.log(jResp.Emit());

var respStatusCode = resp.StatusCode;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
    console.log("Response Header:");
    console.log(resp.Header);
    console.log("Failed.");
    return;
}

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

var id = jResp.StringOf("id");
var name = jResp.StringOf("name");
var v_type = jResp.StringOf("type");
var contentType = jResp.StringOf("contentType");
var description = jResp.StringOf("description");
var createdAt = jResp.StringOf("createdAt");
var updatedAt = jResp.StringOf("updatedAt");
var sha256 = jResp.StringOf("sha256");
var workspace = jResp.StringOf("workspace");
var creator = jResp.StringOf("creator");
var v_protected = jResp.BoolOf("protected");
var position = jResp.IntOf("position");
var parent = jResp.StringOf("parent");
var i = 0;
var count_i = jResp.SizeOfArray("metadata");
while (i < count_i) {
    jResp.I = i;
    i = i+1;
}