EmbeddedApi.md

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(templateId, 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

import com.dropbox.sign.ApiException;
import com.dropbox.sign.Configuration;
import com.dropbox.sign.api.*;
import com.dropbox.sign.auth.*;
import com.dropbox.sign.model.*;

import java.util.List;

public class Main {
    public static void main(String[] args) {
        var apiClient = Configuration.getDefaultApiClient()
            .setApiKey("YOUR_API_KEY");

        // or, configure Bearer (JWT) authorization: oauth2
        /*
        var apiClient = Configuration.getDefaultApiClient()
            .setBearerToken("YOUR_ACCESS_TOKEN");
        */

        var embeddedApi = new EmbeddedApi(apiClient);

        var data = new EmbeddedEditUrlRequest()
            .ccRoles(List.of(""))
            .mergeFields(List.of());

        var templateId = "5de8179668f2033afac48da1868d0093bf133266";

        try {
            EmbeddedEditUrlResponse result = embeddedApi.embeddedEditUrl(templateId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountCreate");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

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	-

embeddedSignUrl

EmbeddedSignUrlResponse embeddedSignUrl(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

import com.dropbox.sign.ApiException;
import com.dropbox.sign.Configuration;
import com.dropbox.sign.api.*;
import com.dropbox.sign.auth.*;
import com.dropbox.sign.model.*;

public class Example {
    public static void main(String[] args) {
        var apiClient = Configuration.getDefaultApiClient()
            .setApiKey("YOUR_API_KEY");

        // or, configure Bearer (JWT) authorization: oauth2
        /*
        var apiClient = Configuration.getDefaultApiClient()
            .setBearerToken("YOUR_ACCESS_TOKEN");
        */

        var embeddedApi = new EmbeddedApi(apiClient);

        var signatureId = "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b";

        try {
            EmbeddedSignUrlResponse result = embeddedApi.embeddedSignUrl(signatureId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountCreate");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

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	-