Dropbox Sign Developer Documentation

import * as fs from 'fs';
import api from "@dropbox/sign"
import models from "@dropbox/sign"
const apiCaller = new api.ApiAppApi();
apiCaller.username = "YOUR_API_KEY";
// apiCaller.accessToken = "YOUR_ACCESS_TOKEN";
const oauth: models.SubOAuth = {
  callbackUrl: "https://example.com/oauth",
  scopes: [
    models.SubOAuth.ScopesEnum.BasicAccountInfo,
    models.SubOAuth.ScopesEnum.RequestSignature,
  ],
};
const whiteLabelingOptions: models.SubWhiteLabelingOptions = {
  primaryButtonColor: "#00b3e6",
  primaryButtonTextColor: "#ffffff",
};
const apiAppCreateRequest: models.ApiAppCreateRequest = {
  name: "My Production App",
  domains: [
    "example.com",
  ],
  customLogoFile: fs.createReadStream("CustomLogoFile.png"),
  oauth: oauth,
  whiteLabelingOptions: whiteLabelingOptions,
};
apiCaller.apiAppCreate(
  apiAppCreateRequest,
).then(response => {
  console.log(response.body);
}).catch(error => {
  console.log("Exception when calling ApiAppApi#apiAppCreate:");
  console.log(error.body);
});

{
  "api_app": {
    "callback_url": null,
    "client_id": "0dd3b823a682527788c4e40cb7b6f7e9",
    "created_at": 1436232339,
    "domains": [
      "example.com"
    ],
    "name": "My Production App",
    "is_approved": false,
    "oauth": {
      "callback_url": "https://example.com/oauth",
      "secret": "98891a1b59f312d04cd88e4e0c498d75",
      "scopes": [
        "basic_account_info",
        "request_signature"
      ]
    },
    "owner_account": {
      "account_id": "dc5deeb9e10b044c591ef2475aafad1d1d3bd888",
      "email_address": "john@example.com"
    },
    "white_labeling_options": {
      "primary_button_color": "#00b3e6",
      "primary_button_text_color": "#ffffff"
    }
  }
}

Creates a new API App.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <username:password>.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

domainslist of stringsRequired

The domain names the ApiApp will be associated with.

namestringRequired

The name you want to assign to the ApiApp.

callback_urlstringOptional

The URL at which the ApiApp should receive event callbacks.

custom_logo_filestringOptionalformat: "binary"

An image file to use as a custom logo in embedded contexts. (Only applies to some API plans)

oauthobjectOptional

OAuth related parameters.

optionsobjectOptional

Additional options supported by API App.

white_labeling_optionsobjectOptional

An array of elements and values serialized to a string, to be used to customize the app’s signer page. (Only applies to some API plans)

Take a look at our white labeling guide to learn more.

An array of elements and values serialized to a string, to be used to customize the app's signer page. (Only applies to some API plans) Take a look at our [white labeling guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more.

Response headers

X-RateLimit-Limitinteger

The maximum number of requests per hour that you can make.

X-RateLimit-Remaininginteger

The number of requests remaining in the current rate limit window.

X-Ratelimit-Resetinteger

The Unix time at which the rate limit will reset to its maximum.

Response

successful operation

api_appobject

Contains information about an API App.

warningslist of objects or null

A list of warnings.

Create API App

Authentication

Request

Response headers

Response

Errors