PHP ActiveX

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. PHP ActiveX

<?php

$success = 0;

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

$http = new COM("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');

$sbResponseBody = new COM("Chilkat.StringBuilder");
$success = $http->QuickGetSb('https://staging-api.yousign.com/users',$sbResponseBody);
if ($success == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $http->LastStatus;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $http->LastHeader . "\n";
    print 'Failed.' . "\n";
    exit;
}

// 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) {
    $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;
}


?>