(Delphi ActiveX) Yousign: Making your first API call

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

For more information, see https://dev.yousign.com/?version=latest#c803dbec-2afb-4b2d-b70b-b42e5c8cbc9a

Chilkat for Delphi Downloads Chilkat ActiveX DLL for Delphi Chilkat non-ActiveX DLL for Delphi * The examples here use the ActiveX DLL.

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Chilkat_TLB;

...

procedure TForm1.Button1Click(Sender: TObject);
var
http: TChilkatHttp;
success: Integer;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
name: WideString;
strVal: WideString;
id: WideString;
firstname: WideString;
lastname: WideString;
email: WideString;
title: WideString;
phone: WideString;
status: WideString;
organization: WideString;
permission: WideString;
groupId: WideString;
groupName: WideString;
createdAt: WideString;
updatedAt: WideString;
deleted: Integer;
deletedAt: WideString;
inweboUserRequest: WideString;
samlNameId: WideString;
defaultSignImage: WideString;
notificationsProcedure: Integer;
fastSign: Integer;
fullName: WideString;
i: Integer;
count_i: Integer;

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

http := TChilkatHttp.Create(Self);

// 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');

sbResponseBody := TChilkatStringBuilder.Create(Self);
success := http.QuickGetSb('https://staging-api.yousign.com/users',sbResponseBody.ControlInterface);
if (success = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());

respStatusCode := http.LastStatus;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(http.LastHeader);
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

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

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

i := 0;
count_i := jResp.SizeOfArray('group.permissions');
while i < count_i do
  begin
    jResp.I := i;
    strVal := jResp.StringOf('group.permissions[i]');
    i := i + 1;
  end;

i := 0;
count_i := jResp.SizeOfArray('config');
while i < count_i do
  begin
    jResp.I := i;
    i := i + 1;
  end;
end;