JavaScript

Yousign: Making your first API call

See more Yousign Examples

Demonstrates making the simplest of calls to test your API key. This example tests using the sandbox URLs. JavaScript

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 GET 'https://staging-api.yousign.com/users' \
// --header 'Authorization: Bearer YOUR_API_KEY' \
// --header 'Content-Type: application/json'

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

// Adds the "Authorization: Bearer YOUR_API_KEY" header.
http.AuthToken = "YOUR_API_KEY";
http.SetRequestHeader("Content-Type","application/json");

var sbResponseBody = new CkStringBuilder();
success = http.QuickGetSb("https://staging-api.yousign.com/users",sbResponseBody);
if (success == false) {
    console.log(http.LastErrorText);
    return;
}

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

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

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

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

// {
//   "id": "/users/XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
//   "firstname": "John",
//   "lastname": "Doe",
//   "email": "john.doe@yousign.fr",
//   "title": "Developer",
//   "phone": "+33612345678",
//   "status": "activated",
//   "organization": "/organizations/XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
//   "workspaces": [
//     {
//       "id": "/workspaces/XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
//       "name": "Acme"
//     }
//   ],
//   "permission": "ROLE_ADMIN",
//   "group": {
//     "id": "/user_groups/XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
//     "name": "Administrateur",
//     "permissions": [
//       "procedure_write",
//       "procedure_template_write",
//       "procedure_create_from_template",
//       "contact",
//       "sign",
//       "organization",
//       "user",
//       "api_key",
//       "procedure_custom_field",
//       "signature_ui",
//       "certificate",
//       "archive"
//     ]
//   },
//   "createdAt": "2018-12-01T09:42:25+01:00",
//   "updatedAt": "2018-12-01T09:42:25+01:00",
//   "deleted": false,
//   "deletedAt": null,
//   "config": [
//   ],
//   "inweboUserRequest": null,
//   "samlNameId": null,
//   "defaultSignImage": null,
//   "notifications": {
//     "procedure": true
//   },
//   "fastSign": false,
//   "fullName": "John Doe"
// }

// 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 name;
var strVal;

var id = jResp.StringOf("id");
var firstname = jResp.StringOf("firstname");
var lastname = jResp.StringOf("lastname");
var email = jResp.StringOf("email");
var title = jResp.StringOf("title");
var phone = jResp.StringOf("phone");
var status = jResp.StringOf("status");
var organization = jResp.StringOf("organization");
var permission = jResp.StringOf("permission");
var groupId = jResp.StringOf("group.id");
var groupName = jResp.StringOf("group.name");
var createdAt = jResp.StringOf("createdAt");
var updatedAt = jResp.StringOf("updatedAt");
var deleted = jResp.BoolOf("deleted");
var deletedAt = jResp.StringOf("deletedAt");
var inweboUserRequest = jResp.StringOf("inweboUserRequest");
var samlNameId = jResp.StringOf("samlNameId");
var defaultSignImage = jResp.StringOf("defaultSignImage");
var notificationsProcedure = jResp.BoolOf("notifications.procedure");
var fastSign = jResp.BoolOf("fastSign");
var fullName = jResp.StringOf("fullName");
var i = 0;
var count_i = jResp.SizeOfArray("workspaces");
while (i < count_i) {
    jResp.I = i;
    id = jResp.StringOf("workspaces[i].id");
    name = jResp.StringOf("workspaces[i].name");
    i = i+1;
}

i = 0;
count_i = jResp.SizeOfArray("group.permissions");
while (i < count_i) {
    jResp.I = i;
    strVal = jResp.StringOf("group.permissions[i]");
    i = i+1;
}

i = 0;
count_i = jResp.SizeOfArray("config");
while (i < count_i) {
    jResp.I = i;
    i = i+1;
}