EmbeddedApi.md

Dropbox.Sign.Api.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

EmbeddedEditUrlResponse EmbeddedEditUrl (string templateId, EmbeddedEditUrlRequest embeddedEditUrlRequest)

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

using System;
using System.Collections.Generic;
using System.IO;
using Dropbox.Sign.Api;
using Dropbox.Sign.Client;
using Dropbox.Sign.Model;

public class Example
{
    public static void Main()
    {
        var config = new Configuration();
        // Configure HTTP basic authorization: api_key
        config.Username = "YOUR_API_KEY";

        // or, configure Bearer (JWT) authorization: oauth2
        // config.AccessToken = "YOUR_BEARER_TOKEN";

        var embeddedApi = new EmbeddedApi(config);

        var data = new EmbeddedEditUrlRequest(
            ccRoles: new List<string>(){""},
            mergeFields: new List<SubMergeField>()
        );

        var templateId = "5de8179668f2033afac48da1868d0093bf133266";

        try
        {
            var result = embeddedApi.EmbeddedEditUrl(templateId, data);
            Console.WriteLine(result);
        }
        catch (ApiException e)
        {
            Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message);
            Console.WriteLine("Status Code: " + e.ErrorCode);
            Console.WriteLine(e.StackTrace);
        }
    }
}

Using the EmbeddedEditUrlWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Get Embedded Template Edit URL
    ApiResponse<EmbeddedEditUrlResponse> response = apiInstance.EmbeddedEditUrlWithHttpInfo(templateId, embeddedEditUrlRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling EmbeddedApi.EmbeddedEditUrlWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
templateId	string	The id of the template to edit.
embeddedEditUrlRequest	EmbeddedEditUrlRequest

Return type

EmbeddedEditUrlResponse

Authorization

api_key, oauth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	successful operation	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset -
4XX	failed_operation	-

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

EmbeddedSignUrl

EmbeddedSignUrlResponse EmbeddedSignUrl (string signatureId)

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

using System;
using System.Collections.Generic;
using System.IO;
using Dropbox.Sign.Api;
using Dropbox.Sign.Client;
using Dropbox.Sign.Model;

public class Example
{
    public static void Main()
    {
        var config = new Configuration();
        // Configure HTTP basic authorization: api_key
        config.Username = "YOUR_API_KEY";

        // or, configure Bearer (JWT) authorization: oauth2
        // config.AccessToken = "YOUR_BEARER_TOKEN";

        var embeddedApi = new EmbeddedApi(config);

        var signatureId = "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b";

        try
        {
            var result = embeddedApi.EmbeddedSignUrl(signatureId);
            Console.WriteLine(result);
        }
        catch (ApiException e)
        {
            Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message);
            Console.WriteLine("Status Code: " + e.ErrorCode);
            Console.WriteLine(e.StackTrace);
        }
    }
}

Using the EmbeddedSignUrlWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Get Embedded Sign URL
    ApiResponse<EmbeddedSignUrlResponse> response = apiInstance.EmbeddedSignUrlWithHttpInfo(signatureId);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling EmbeddedApi.EmbeddedSignUrlWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

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

Return type

EmbeddedSignUrlResponse

Authorization

api_key, oauth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	successful operation	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset -
4XX	failed_operation	-

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