Skip to content

EmbeddedApi.md

Latest commit

 

History

History
140 lines (93 loc) · 3.93 KB

EmbeddedApi.md

File metadata and controls

140 lines (93 loc) · 3.93 KB

Dropbox\Sign\EmbeddedApi

All URIs are relative to https://api.hellosign.com/v3.

Method HTTP request Description
embeddedEditUrl() POST /embedded/edit_url/{template_id} Get Embedded Template Edit URL
embeddedSignUrl() GET /embedded/sign_url/{signature_id} Get Embedded Sign URL

embeddedEditUrl()

embeddedEditUrl($template_id, $embedded_edit_url_request): \Dropbox\Sign\Model\EmbeddedEditUrlResponse

Get Embedded Template Edit URL

Retrieves an embedded object containing a template url that can be opened in an iFrame. Note that only templates created via the embedded template process are available to be edited with this endpoint.

Example

<?php

namespace Dropbox\SignSandbox;

require_once __DIR__ . '/../vendor/autoload.php';

use SplFileObject;
use Dropbox;

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
$config->setUsername("YOUR_API_KEY");
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

$merge_fields = [
];

$embedded_edit_url_request = (new Dropbox\Sign\Model\EmbeddedEditUrlRequest())
    ->setCcRoles([
        "",
    ])
    ->setMergeFields($merge_fields);

try {
    $response = (new Dropbox\Sign\Api\EmbeddedApi(config: $config))->embeddedEditUrl(
        template_id: "f57db65d3f933b5316d398057a36176831451a35",
        embedded_edit_url_request: $embedded_edit_url_request,
    );

    print_r($response);
} catch (Dropbox\Sign\ApiException $e) {
    echo "Exception when calling EmbeddedApi#embeddedEditUrl: {$e->getMessage()}";
}

Parameters

Name Type Description Notes
template_id string The id of the template to edit.
embedded_edit_url_request \Dropbox\Sign\Model\EmbeddedEditUrlRequest

Return type

\Dropbox\Sign\Model\EmbeddedEditUrlResponse

Authorization

api_key, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

embeddedSignUrl()

embeddedSignUrl($signature_id): \Dropbox\Sign\Model\EmbeddedSignUrlResponse

Get Embedded Sign URL

Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API.

Example

<?php

namespace Dropbox\SignSandbox;

require_once __DIR__ . '/../vendor/autoload.php';

use SplFileObject;
use Dropbox;

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
$config->setUsername("YOUR_API_KEY");
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

try {
    $response = (new Dropbox\Sign\Api\EmbeddedApi(config: $config))->embeddedSignUrl(
        signature_id: "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b",
    );

    print_r($response);
} catch (Dropbox\Sign\ApiException $e) {
    echo "Exception when calling EmbeddedApi#embeddedSignUrl: {$e->getMessage()}";
}

Parameters

Name Type Description Notes
signature_id string The id of the signature to get a signature url for.

Return type

\Dropbox\Sign\Model\EmbeddedSignUrlResponse

Authorization

api_key, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]