C#
C#
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.Chilkat C# Downloads
bool success = false;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Chilkat.Http http = new Chilkat.Http();
// 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");
Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
success = http.QuickGetSb("https://staging-api.yousign.com/users",sbResponseBody);
if (success == false) {
Debug.WriteLine(http.LastErrorText);
return;
}
Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;
Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());
int respStatusCode = http.LastStatus;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
Debug.WriteLine("Response Header:");
Debug.WriteLine(http.LastHeader);
Debug.WriteLine("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
string name;
string strVal;
string id = jResp.StringOf("id");
string firstname = jResp.StringOf("firstname");
string lastname = jResp.StringOf("lastname");
string email = jResp.StringOf("email");
string title = jResp.StringOf("title");
string phone = jResp.StringOf("phone");
string status = jResp.StringOf("status");
string organization = jResp.StringOf("organization");
string permission = jResp.StringOf("permission");
string groupId = jResp.StringOf("group.id");
string groupName = jResp.StringOf("group.name");
string createdAt = jResp.StringOf("createdAt");
string updatedAt = jResp.StringOf("updatedAt");
bool deleted = jResp.BoolOf("deleted");
string deletedAt = jResp.StringOf("deletedAt");
string inweboUserRequest = jResp.StringOf("inweboUserRequest");
string samlNameId = jResp.StringOf("samlNameId");
string defaultSignImage = jResp.StringOf("defaultSignImage");
bool notificationsProcedure = jResp.BoolOf("notifications.procedure");
bool fastSign = jResp.BoolOf("fastSign");
string fullName = jResp.StringOf("fullName");
int i = 0;
int 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;
}