Get started with the Dropbox Sign API
Explore the Dropbox Sign API ecosystem, understand its core components, and prepare your environment to start building integrations.
5 Minute(n) Lesezeit
You've been asked to connect Dropbox Sign with another application, automate document workflows, or build a signing experience directly into your product. To do that, you'll use the Dropbox Sign API.
Whether you're building a new integration or managing an existing one, this course will help you understand how the Dropbox Sign API works, from authentication and embedded experiences to monitoring integrations and preparing them for production.
What can you build with the Dropbox Sign API?
The Dropbox Sign API allows developers and technical teams to automate document workflows and integrate electronic signatures directly into their applications and business processes.
Common use cases include:
Automated signature requests
Automatically send documents for signature from your application without requiring users to manually create requests in Dropbox Sign.
Examples:
Employee onboarding systems
CRM workflows
Contract management platforms
Embedded signing experiences
Allow users to sign documents without leaving your application.
Instead of redirecting signers to Dropbox Sign, the signing experience is displayed directly within your product.
Embedded requesting workflows
Allow users to prepare and send signature requests from within your application.
This can create a more seamless experience while maintaining your existing workflow.
Embedded templates
Allow users to create or use templates directly within your application.
This can help standardize recurring document processes while keeping users within your platform.
Custom integrations
Build integrations that connect Dropbox Sign with:
Internal business systems
Customer portals
Workflow automation platforms
Third-party applications
The Dropbox Sign API provides the flexibility to create experiences tailored to your organization's needs.
Accessing API settings
API management tools are available directly within Dropbox Sign.
To access API settings:
Sign in to Dropbox Sign.
Open your account settings.
Select the API tab.
The API area provides access to:
API Keys
API Apps
Callback configuration
API Dashboard
This is where you'll manage and monitor your integrations.
Live and test mode
When building a Dropbox Sign integration, you'll typically work in two environments: test mode and live mode.
Most integrations begin in test mode, which lets you build and test API workflows without creating legally binding signature requests.
Whether a request is treated as test or production is controlled by the test_mode parameter in your API request. Include it while testing, then remove it when you're ready to send production requests.
Documents sent in test mode are clearly marked with a watermark, making it easy to experiment and validate your integration before moving to production.
Once your integration has been tested and is ready for real users, you can switch to live mode to send legally binding signature requests.
Note
Most API features can be explored in test mode, even without a paid plan. However, the features available in live mode depend on your Dropbox Sign subscription.
If something works as expected in test mode but not in production, check whether the endpoints or features you're using are included in your current plan.
Understanding the API ecosystem
Before building an integration, it's helpful to understand the key components that work together within the Dropbox Sign API platform.
Throughout this course, you'll explore four core components:
API keys
API keys are credentials that identify and authenticate your integration, allowing your application to securely communicate with the Dropbox Sign API.
Think of an API key as your integration's identity whenever it connects to Dropbox Sign.
API apps
API Apps support embedded and OAuth-based workflows.
They define how your integration interacts with Dropbox Sign and allow you to configure app-specific settings.
API dashboard
The API dashboard provides visibility into API usage, request volume, and error activity.
Admins and developers use the dashboard to monitor integration health and performance.
Callbacks
Callbacks, also known as webhooks, allow Dropbox Sign to notify your systems when important events occur.
Examples include:
A document is signed.
A request is completed.
A signer declines a document.
Callbacks help keep your systems synchronized with Dropbox Sign activity.
How these components work together
A typical integration often follows this pattern:
Authenticate using an API key.
Send requests or create workflows through the API.
Configure API apps when embedded or OAuth functionality is required.
Monitor activity through the API dashboard.
Receive updates through callbacks.
Understanding these components now will make the rest of this course easier to follow.
SDKs
Most developers interact with the Dropbox Sign API through an official Software Development Kit (SDK) rather than making raw API calls.
Dropbox Sign provides SDKs for:
Node
Python
PHP
.NET
Ruby
Java
SDKs simplify development by handling common tasks such as authentication and request formatting, allowing you to focus on building your integration.
If you're starting a new integration, check whether an official SDK is available for your programming language before building from scratch.
Tip
Not every integration requires an API app. Many standard, non-embedded integrations can use API keys alone.
API apps become important when you're building:
Embedded signing
Embedded requesting
Embedded templates
OAuth workflows
As you progress through this course, you'll learn when API apps are required and how to configure them.
You've built a solid understanding of the Dropbox Sign API ecosystem and the tools that support every integration.