(PHP ActiveX) Yousign Create Procedure after Uploading the PDF

Demonstrates the 2nd step of Yousign procedure creation. This is the call to create the procedure after previously uploading the PDF file.

For more information, see https://dev.yousign.com/?version=latest#c2e03a8b-f782-4d3e-96d1-04517c083497

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows Note: The php_com_dotnet.dll may need to be enabled inside of php.ini.

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

// Implements the following CURL command:

// curl --location --request POST 'https://staging-api.yousign.com/procedures' \
// --header 'Authorization: Bearer YOUR_API_KEY' \
// --header 'Content-Type: application/json' \
// --data-raw '{
//     "name": "My first procedure",
//     "description": "Awesome! Here is the description of my first procedure",
//     "members": [
//         {
//             "firstname": "John",
//             "lastname": "Doe",
//             "email": "john.doe@yousign.fr",
//             "phone": "+33612345678",
//             "fileObjects": [
//                 {
//                     "file": "/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
//                     "page": 2,
//                     "position": "230,499,464,589",
//                     "mention": "Read and approved",
//                     "mention2": "Signed by John Doe"
//                 }
//             ]
//         }
//     ]
// }'

// 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": "My first procedure",
//   "description": "Awesome! Here is the description of my first procedure",
//   "members": [
//     {
//       "firstname": "John",
//       "lastname": "Doe",
//       "email": "john.doe@yousign.fr",
//       "phone": "+33612345678",
//       "fileObjects": [
//         {
//           "file": "/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
//           "page": 2,
//           "position": "230,499,464,589",
//           "mention": "Read and approved",
//           "mention2": "Signed by John Doe"
//         }
//       ]
//     }
//   ]
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('name','My first procedure');
$json->UpdateString('description','Awesome! Here is the description of my first procedure');
$json->UpdateString('members[0].firstname','John');
$json->UpdateString('members[0].lastname','Doe');
$json->UpdateString('members[0].email','john.doe@yousign.fr');
$json->UpdateString('members[0].phone','+33612345678');
$json->UpdateString('members[0].fileObjects[0].file','/files/6c123a8d-e5cf-4534-8da0-81886376ba2c');
$json->UpdateInt('members[0].fileObjects[0].page',2);
$json->UpdateString('members[0].fileObjects[0].position','230,499,464,589');
$json->UpdateString('members[0].fileObjects[0].mention','Read and approved');
$json->UpdateString('members[0].fileObjects[0].mention2','Signed by John Doe');

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

// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://staging-api.yousign.com/procedures','application/json',$json);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$resp->GetBodySb($sbResponseBody);
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;

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

$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->Header . "\n";
    print 'Failed.' . "\n";

    exit;
}

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

// {
//   "id": "/procedures/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
//   "name": "My first procedure",
//   "description": "Awesome! Here is the description of my first procedure",
//   "createdAt": "2018-12-01T11:49:11+01:00",
//   "updatedAt": "2018-12-01T11:49:11+01:00",
//   "finishedAt": null,
//   "expiresAt": null,
//   "status": "active",
//   "creator": null,
//   "creatorFirstName": null,
//   "creatorLastName": null,
//   "workspace": "/workspaces/XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
//   "template": false,
//   "ordered": false,
//   "parent": null,
//   "metadata": [
//   ],
//   "config": [
//   ],
//   "members": [
//     {
//       "id": "/members/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
//       "user": null,
//       "type": "signer",
//       "firstname": "John",
//       "lastname": "Doe",
//       "email": "john.doe@yousign.fr",
//       "phone": "+33612345678",
//       "position": 1,
//       "createdAt": "2018-12-01T11:49:11+01:00",
//       "updatedAt": "2018-12-01T11:49:11+01:00",
//       "finishedAt": null,
//       "status": "pending",
//       "fileObjects": [
//         {
//           "id": "/file_objects/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
//           "file": {
//             "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:49:11+01:00",
//             "sha256": "bb57ae2b2ca6ad0133a699350d1a6f6c8cdfde3cf872cf526585d306e4675cc2",
//             "metadata": [
//             ],
//             "workspace": "/workspaces/XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
//             "creator": null,
//             "protected": false,
//             "position": 0,
//             "parent": null
//           },
//           "page": 2,
//           "position": "230,499,464,589",
//           "fieldName": null,
//           "mention": "Read and approved",
//           "mention2": "Signed by John Doe",
//           "createdAt": "2018-12-01T11:49:11+01:00",
//           "updatedAt": "2018-12-01T11:49:11+01:00",
//           "parent": null,
//           "reason": "Signed by Yousign"
//         }
//       ],
//       "comment": null,
//       "notificationsEmail": [
//       ],
//       "operationLevel": "custom",
//       "operationCustomModes": [
//         "sms"
//       ],
//       "operationModeSmsConfig": null,
//       "parent": null
//     }
//   ],
//   "subscribers": [
//   ],
//   "files": [
//     {
//       "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:49:11+01:00",
//       "sha256": "bb57ae2b2ca6ad0133a699350d1a6f6c8cdfde3cf872cf526585d306e4675cc2",
//       "metadata": [
//       ],
//       "workspace": "/workspaces/XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
//       "creator": null,
//       "protected": false,
//       "position": 0,
//       "parent": null
//     }
//   ],
//   "relatedFilesEnable": false,
//   "archive": false,
//   "archiveMetadata": [
//   ],
//   "fields": [
//   ],
//   "permissions": [
//   ]
// }

// 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');
$name = $jResp->stringOf('name');
$description = $jResp->stringOf('description');
$createdAt = $jResp->stringOf('createdAt');
$updatedAt = $jResp->stringOf('updatedAt');
$finishedAt = $jResp->stringOf('finishedAt');
$expiresAt = $jResp->stringOf('expiresAt');
$status = $jResp->stringOf('status');
$creator = $jResp->stringOf('creator');
$creatorFirstName = $jResp->stringOf('creatorFirstName');
$creatorLastName = $jResp->stringOf('creatorLastName');
$workspace = $jResp->stringOf('workspace');
$template = $jResp->BoolOf('template');
$ordered = $jResp->BoolOf('ordered');
$parent = $jResp->stringOf('parent');
$relatedFilesEnable = $jResp->BoolOf('relatedFilesEnable');
$archive = $jResp->BoolOf('archive');
$i = 0;
$count_i = $jResp->SizeOfArray('metadata');
while ($i < $count_i) {
    $jResp->I = $i;
    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray('config');
while ($i < $count_i) {
    $jResp->I = $i;
    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray('members');
while ($i < $count_i) {
    $jResp->I = $i;
    $id = $jResp->stringOf('members[i].id');
    $user = $jResp->stringOf('members[i].user');
    $v_type = $jResp->stringOf('members[i].type');
    $firstname = $jResp->stringOf('members[i].firstname');
    $lastname = $jResp->stringOf('members[i].lastname');
    $email = $jResp->stringOf('members[i].email');
    $phone = $jResp->stringOf('members[i].phone');
    $position = $jResp->IntOf('members[i].position');
    $createdAt = $jResp->stringOf('members[i].createdAt');
    $updatedAt = $jResp->stringOf('members[i].updatedAt');
    $finishedAt = $jResp->stringOf('members[i].finishedAt');
    $status = $jResp->stringOf('members[i].status');
    $comment = $jResp->stringOf('members[i].comment');
    $operationLevel = $jResp->stringOf('members[i].operationLevel');
    $operationModeSmsConfig = $jResp->stringOf('members[i].operationModeSmsConfig');
    $parent = $jResp->stringOf('members[i].parent');
    $j = 0;
    $count_j = $jResp->SizeOfArray('members[i].fileObjects');
    while ($j < $count_j) {
        $jResp->J = $j;
        $id = $jResp->stringOf('members[i].fileObjects[j].id');
        $fileId = $jResp->stringOf('members[i].fileObjects[j].file.id');
        $fileName = $jResp->stringOf('members[i].fileObjects[j].file.name');
        $fileType = $jResp->stringOf('members[i].fileObjects[j].file.type');
        $fileContentType = $jResp->stringOf('members[i].fileObjects[j].file.contentType');
        $fileDescription = $jResp->stringOf('members[i].fileObjects[j].file.description');
        $fileCreatedAt = $jResp->stringOf('members[i].fileObjects[j].file.createdAt');
        $fileUpdatedAt = $jResp->stringOf('members[i].fileObjects[j].file.updatedAt');
        $fileSha256 = $jResp->stringOf('members[i].fileObjects[j].file.sha256');
        $fileWorkspace = $jResp->stringOf('members[i].fileObjects[j].file.workspace');
        $fileCreator = $jResp->stringOf('members[i].fileObjects[j].file.creator');
        $fileProtected = $jResp->BoolOf('members[i].fileObjects[j].file.protected');
        $filePosition = $jResp->IntOf('members[i].fileObjects[j].file.position');
        $fileParent = $jResp->stringOf('members[i].fileObjects[j].file.parent');
        $page = $jResp->IntOf('members[i].fileObjects[j].page');
        $position_str = $jResp->stringOf('members[i].fileObjects[j].position');
        $fieldName = $jResp->stringOf('members[i].fileObjects[j].fieldName');
        $mention = $jResp->stringOf('members[i].fileObjects[j].mention');
        $mention2 = $jResp->stringOf('members[i].fileObjects[j].mention2');
        $createdAt = $jResp->stringOf('members[i].fileObjects[j].createdAt');
        $updatedAt = $jResp->stringOf('members[i].fileObjects[j].updatedAt');
        $parent = $jResp->stringOf('members[i].fileObjects[j].parent');
        $reason = $jResp->stringOf('members[i].fileObjects[j].reason');
        $k = 0;
        $count_k = $jResp->SizeOfArray('members[i].fileObjects[j].file.metadata');
        while ($k < $count_k) {
            $jResp->K = $k;
            $k = $k + 1;
        }

        $j = $j + 1;
    }

    $j = 0;
    $count_j = $jResp->SizeOfArray('members[i].notificationsEmail');
    while ($j < $count_j) {
        $jResp->J = $j;
        $j = $j + 1;
    }

    $j = 0;
    $count_j = $jResp->SizeOfArray('members[i].operationCustomModes');
    while ($j < $count_j) {
        $jResp->J = $j;
        $strVal = $jResp->stringOf('members[i].operationCustomModes[j]');
        $j = $j + 1;
    }

    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray('subscribers');
while ($i < $count_i) {
    $jResp->I = $i;
    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray('files');
while ($i < $count_i) {
    $jResp->I = $i;
    $id = $jResp->stringOf('files[i].id');
    $name = $jResp->stringOf('files[i].name');
    $v_type = $jResp->stringOf('files[i].type');
    $contentType = $jResp->stringOf('files[i].contentType');
    $description = $jResp->stringOf('files[i].description');
    $createdAt = $jResp->stringOf('files[i].createdAt');
    $updatedAt = $jResp->stringOf('files[i].updatedAt');
    $sha256 = $jResp->stringOf('files[i].sha256');
    $workspace = $jResp->stringOf('files[i].workspace');
    $creator = $jResp->stringOf('files[i].creator');
    $v_protected = $jResp->BoolOf('files[i].protected');
    $position = $jResp->IntOf('files[i].position');
    $parent = $jResp->stringOf('files[i].parent');
    $j = 0;
    $count_j = $jResp->SizeOfArray('files[i].metadata');
    while ($j < $count_j) {
        $jResp->J = $j;
        $j = $j + 1;
    }

    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray('archiveMetadata');
while ($i < $count_i) {
    $jResp->I = $i;
    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray('fields');
while ($i < $count_i) {
    $jResp->I = $i;
    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray('permissions');
while ($i < $count_i) {
    $jResp->I = $i;
    $i = $i + 1;
}


?>