Skip to content

EmbeddedApi.md

Latest commit

 

History

History
131 lines (90 loc) · 3.61 KB

EmbeddedApi.md

File metadata and controls

131 lines (90 loc) · 3.61 KB

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(templateId: string, embeddedEditUrlRequest: EmbeddedEditUrlRequest): 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.

TypeScript Example

import * as fs from 'fs';
import api from "@dropbox/sign"
import models from "@dropbox/sign"

const apiCaller = new api.EmbeddedApi();
apiCaller.username = "YOUR_API_KEY";
// apiCaller.accessToken = "YOUR_ACCESS_TOKEN";

const mergeFields = [
];

const embeddedEditUrlRequest: models.EmbeddedEditUrlRequest = {
  ccRoles: [
    "",
  ],
  mergeFields: mergeFields,
};

apiCaller.embeddedEditUrl(
  "f57db65d3f933b5316d398057a36176831451a35", // templateId
  embeddedEditUrlRequest,
).then(response => {
  console.log(response.body);
}).catch(error => {
  console.log("Exception when calling EmbeddedApi#embeddedEditUrl:");
  console.log(error.body);
});

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

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

embeddedSignUrl()

embeddedSignUrl(signatureId: string): 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.

TypeScript Example

import * as fs from 'fs';
import api from "@dropbox/sign"
import models from "@dropbox/sign"

const apiCaller = new api.EmbeddedApi();
apiCaller.username = "YOUR_API_KEY";
// apiCaller.accessToken = "YOUR_ACCESS_TOKEN";

apiCaller.embeddedSignUrl(
  "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b", // signatureId
).then(response => {
  console.log(response.body);
}).catch(error => {
  console.log("Exception when calling EmbeddedApi#embeddedSignUrl:");
  console.log(error.body);
});

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

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