PHP Migration Guide

1
<?php
2
3
require_once __DIR__ . "/vendor/autoload.php";
4
5
use HelloSign;
6
7
$client = new HelloSign\Client($apikey);

1
<?php
2
3
require_once 'vendor/autoload.php';
4
5
// API Key config
6
$client = new HelloSign\Client($apikey);
7
8
// Email/Password config
9
$client = new HelloSign\Client($email_address, $password);
10
11
// OAuth config
12
$client = new HelloSign\Client($access_token); //instance of HelloSign\OAuthToken

1
$signer1 = new Dropbox\Sign\Model\SubSignatureRequestSigner([
2
    "email_address" => "jack@example.com",
3
    "name"          => "Jack",
4
    "order"         => 0,
5
]);
6
7
$attachment1 = new Dropbox\Sign\Model\SubAttachment([
8
    "name"         => "Attachment 1",
9
    "instructions" => "Please download this file",
10
    "signer_index" => 0,
11
    "required"     => true,
12
]);

1
<?php
2
3
require_once __DIR__ . "/vendor/autoload.php";
4
5
$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
6
7
$config->setUsername("YOUR_API_KEY");
8
9
$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config);
10
11
$data = new Dropbox\Sign\Model\SignatureRequestRemindRequest();
12
$data->setEmailAddress("john@example.com");
13
14
$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f";
15
16
try {
17
    // No HTTP headers included:
18
    // $result = $signatureRequestApi->signatureRequestGet($signatureRequestId);
19
20
    $result = $signatureRequestApi->signatureRequestGetWithHttpInfo($signatureRequestId);
21
    print_r($result);
22
} catch (Dropbox\Sign\ApiException $e) {
23
    $error = $e->getResponseObject();
24
    echo "Exception when calling Dropbox Sign API: "
25
        . print_r($error->getError());
26
}

1
$request->setFormFieldsPerDocument(
2
    [
3
        [ //document 1
4
            [ //field 1
5
                "api_id"   => $random_prefix . "_1",
6
                "name"     => "",
7
                "type"     => "text",
8
                "x"        => 112,
9
                "y"        => 328,
10
                "width"    => 100,
11
                "height"   => 16,
12
                "required" => true,
13
                "signer"   => 0
14
            ],
15
            [ //field 2
16
                "api_id"   => $random_prefix . "_2",
17
                "name"     => "",
18
                "type"     => "signature",
19
                "x"        => 530,
20
                "y"        => 415,
21
                "width"    => 150,
22
                "height"   => 30,
23
                "required" => true,
24
                "signer"   => 1
25
            ],
26
        ],
27
    ],
28
);

1
$form_field_1 = Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature::init([
2
    "document_index" => 0,
3
    "api_id"         => "4688957689",
4
    "name"           => "signature1",
5
    "x"              => 5,
6
    "y"              => 7,
7
    "width"          => 60,
8
    "height"         => 30,
9
    "required"       => true,
10
    "signer"         => 0,
11
    "page"           => 1,
12
]);

1
{
2
  "signers": {
3
    "Client": {
4
      "name": "George",
5
      "email_address": "george@example.com"
6
    },
7
    "Manager": {
8
      "name": "Bob",
9
      "email_address": "bob@example.com"
10
    }
11
  }
12
}

1
<?php
2
3
require_once __DIR__ . "/vendor/autoload.php";
4
5
$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
6
7
$config->setUsername("YOUR_API_KEY");
8
9
$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config);
10
11
$data = new Dropbox\Sign\Model\SignatureRequestSendWithTemplateRequest();
12
$data->setTemplateIds(["c26b8a16784a872da37ea946b9ddec7c1e11dff6"])
13
    ->setSubject("Purchase Order")
14
    ->setMessage("Glad we could come to an agreement.")
15
    ->setSigners([
16
        Dropbox\Sign\Model\SubSignatureRequestTemplateSigner::init([
17
            "role"          => "Client",
18
            "name"          => "George",
19
            "email_address" => "george@example.com",
20
        ]),
21
        Dropbox\Sign\Model\SubSignatureRequestTemplateSigner::init([
22
            "role"          => "Manager",
23
            "name"          => "Bob",
24
            "email_address" => "bob@example.com",
25
        ]),
26
    ]);
27
28
try {
29
    $result = $signatureRequestApi->signatureRequestSendWithTemplate($data);
30
    print_r($result);
31
} catch (Dropbox\Sign\ApiException $e) {
32
    $error = $e->getResponseObject();
33
    echo "Exception when calling Dropbox Sign API: "
34
        . print_r($error->getError());
35
}

1
{
2
  "ccs": {
3
    "Client": "george@example.com",
4
    "Manager": "bob@example.com"
5
  }
6
}

1
<?php
2
3
require_once __DIR__ . "/vendor/autoload.php";
4
5
$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
6
7
$config->setUsername("YOUR_API_KEY");
8
9
$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config);
10
11
$data = new Dropbox\Sign\Model\SignatureRequestSendWithTemplateRequest();
12
$data->setTemplateIds(["c26b8a16784a872da37ea946b9ddec7c1e11dff6"])
13
    ->setSubject("Purchase Order")
14
    ->setMessage("Glad we could come to an agreement.")
15
    ->setSigners([
16
        Dropbox\Sign\Model\SubSignatureRequestTemplateSigner::init([
17
            "role"          => "Client",
18
            "name"          => "George",
19
            "email_address" => "george@example.com",
20
        ]),
21
        Dropbox\Sign\Model\SubSignatureRequestTemplateSigner::init([
22
            "role"          => "Manager",
23
            "name"          => "Bob",
24
            "email_address" => "bob@example.com",
25
        ]),
26
    ])
27
    ->setCcs([
28
        Dropbox\Sign\Model\SubCC::init([
29
            "role"          => "Client",
30
            "email_address" => "george@example.com",
31
        ]),
32
        Dropbox\Sign\Model\SubCC::init([
33
            "role"          => "Manager",
34
            "email_address" => "bob@example.com",
35
        ]),
36
    ]);
37
38
try {
39
    $result = $signatureRequestApi->signatureRequestSendWithTemplate($data);
40
    print_r($result);
41
} catch (Dropbox\Sign\ApiException $e) {
42
    $error = $e->getResponseObject();
43
    echo "Exception when calling Dropbox Sign API: "
44
        . print_r($error->getError());
45
}

1
{
2
  "custom_fields": {
3
    "company": {
4
      "value": "ABC Corp",
5
      "required": true
6
    }
7
  }
8
}

1
<?php
2
3
require_once __DIR__ . "/vendor/autoload.php";
4
5
$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
6
7
$config->setUsername("YOUR_API_KEY");
8
9
$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config);
10
11
$data = new Dropbox\Sign\Model\SignatureRequestSendWithTemplateRequest();
12
$data->setTemplateIds(["c26b8a16784a872da37ea946b9ddec7c1e11dff6"])
13
    ->setSubject("Purchase Order")
14
    ->setMessage("Glad we could come to an agreement.")
15
    ->setSigners([
16
        Dropbox\Sign\Model\SubSignatureRequestTemplateSigner::init([
17
            "role"          => "Client",
18
            "name"          => "George",
19
            "email_address" => "george@example.com",
20
        ]),
21
        Dropbox\Sign\Model\SubSignatureRequestTemplateSigner::init([
22
            "role"          => "Manager",
23
            "name"          => "Bob",
24
            "email_address" => "bob@example.com",
25
        ]),
26
    ])
27
    ->setCustomFields([
28
        Dropbox\Sign\Model\SubCustomField::init([
29
            "name"     => "company",
30
            "value"    => "ABC Corp",
31
            "required" => true,
32
        ]),
33
    ]);
34
35
try {
36
    $result = $signatureRequestApi->signatureRequestSendWithTemplate($data);
37
    print_r($result);
38
} catch (Dropbox\Sign\ApiException $e) {
39
    $error = $e->getResponseObject();
40
    echo "Exception when calling Dropbox Sign API: "
41
        . print_r($error->getError());
42
}

1
// Signature request
2
$request->addFile('nda.pdf'); // Adding file from local;
3
4
// API app request
5
$request->setLogo('logo_file.png'); // Adding file from local;

1
// Binary stream
2
$client->getFiles(
3
    $signature_request_id,
4
    "{$dest_file_path}/{$title}.zip",
5
    HelloSign\SignatureRequest::FILE_TYPE_ZIP
6
);
7
8
// Auto-generated URL
9
$client->getFiles($signature_request_id);

1
$client->getTemplateFiles(
2
    $tenokate_id,
3
    "{$dest_file_path}/{$title}.zip",
4
    "pdf"
5
);

1
$client->createEmbeddedSignatureRequest($embedded_request);
2
3
$client->sendSignatureRequest($request);
4
5
$client->getSignatureRequest($signature_request_id);
6
7
$client->getAccount();
8
9
$client->getTemplate($templateId);

1
<?php
2
3
require_once 'vendor/autoload.php';
4
5
$client = new HelloSign\Client($apikey);
6
7
$clientId = "7deab03c18acf4097fb675f2a566d49f";
8
9
$apiApp = new ApiApp();
10
$apiApp->setName('Updating Name')
11
->setWhiteLabeling([
12
  "primary_button_color" => "#00B3E6",
13
  "primary_button_text_color" => "#FFFFFF"
14
])
15
->setLogo('my_company_logo.png');
16
17
$response = $client->updateApiApp($clientId, $apiApp);
18
print_r($response);

1
<?php
2
require_once 'vendor/autoload.php';
3
4
$client = new HelloSign\Client($apikey);
5
6
// Create the SignatureRequest object
7
$request = new HelloSign\SignatureRequest;
8
$request->enableTestMode();
9
$request->setTitle('NDA with Acme Co.');
10
$request->setSubject('The NDA we talked about');
11
$request->setMessage('Please sign this NDA and let\'s discuss.');
12
$request->addSigner('jack@example.com', 'Jack');
13
$request->addSigner('jill@example.com', 'Jill');
14
$request->addCC('lawyer@example.com');
15
$request->addFile('nda.pdf'); //Adding file from local
16
17
// Turn it into an embedded request
18
$embedded_request = new HelloSign\EmbeddedSignatureRequest($request, $client_id);
19
20
// Send it to HelloSign
21
$response = $client->createEmbeddedSignatureRequest($embedded_request);
22
23
// Grab the signature ID for the signature page that will be embedded in the
24
// page (for the demo, we'll just use the first one)
25
$signatures   = $response->getSignatures();
26
$signature_id = $signatures[0]->getId();
27
28
// Retrieve the URL to sign the document
29
$response = $client->getEmbeddedSignUrl($signature_id);
30
31
// Store it to use with the embedded.js HelloSign.open() call
32
$sign_url = $response->getSignUrl();

1
<?php
2
3
require_once 'vendor/autoload.php';
4
5
$client = new HelloSign\Client($apikey);
6
7
$response = $client->getSignatureRequest($signature_request_id);
8
print_r($response);

1
<?php
2
require_once 'vendor/autoload.php';
3
4
$client = new HelloSign\Client($apikey);
5
6
$templateId = '11b77b90f5e7156d961d4bbe26b872ca04edddbb';
7
8
$response = $client->getTemplate($templateId);
9
10
print_r($response);
11
print_r($response->getTitle());
12
print_r($response->getSignerRoles());

1
$request = new HelloSign\TemplateSignatureRequest;
2
$request->enableTestMode();
3
$request->setTemplateId($template->getId());
4
$request->setSubject('Purchase Order');
5
$request->setMessage('Glad we could come to an agreement.');
6
$request->setSigner('Client', 'george@example.com', 'George');
7
$request->setCC('Accounting', 'accounting@example.com');
8
$request->setCustomFieldValue('Cost', '$20,000');
9
10
$response = $client->sendTemplateSignatureRequest($request);

1
<?php
2
require_once 'vendor/autoload.php';
3
4
$client = new HelloSign\Client($apikey);
5
6
$account = $client->getAccount();
7
8
print_r($account->toArray());

1
<?php
2
3
require_once 'vendor/autoload.php';
4
5
$client = new HelloSign\Client($apikey);
6
7
$signature_request_id = "e541d3d8df85c8e944f0793c8530e915d750";
8
9
// Retrieve the signature request object
10
$response = $client->getSignatureRequest($signature_request_id);
11
12
// Set the destination path for the file
13
$dest_file_path = 'Signature Request Files';
14
// Retrieve the title from the signature request object
15
$title = $response->getTitle();
16
17
// Save the file locally
18
$client->getFiles(
19
    $signature_request_id,
20
    "{$dest_file_path}/{$title}.zip",
21
    HelloSign\SignatureRequest::FILE_TYPE_ZIP
22
);
23
24
// Or
25
26
// Retrieve an auto-generated URL
27
$client->getFiles($signature_request_id);