Dropbox Sign Python SDK

1.10.0 · active · verified Sat Apr 11

The official Python SDK for interacting with the Dropbox Sign API (formerly HelloSign). It provides a programmatic interface to send signature requests, manage documents, handle templates, and more. The current version is 1.10.0, with a release cadence that generally follows API updates and bug fixes.

Warnings

breaking The package name and entire module structure changed from `hellosign-sdk` to `dropbox-sign`. This is not a simple upgrade.
Fix: You must uninstall `hellosign-sdk` and install `dropbox-sign`. All import paths and class names will need to be updated. Refer to the official migration guide on GitHub: `github.com/hellosign/dropbox-sign-python#migration-from-hellosign-sdk-to-dropbox-sign-python-sdk`
gotcha API Key vs. OAuth2 for authentication: Ensure you use the correct configuration method for your chosen authentication flow.
Fix: For API Key authentication, set `Configuration.api_key = 'YOUR_API_KEY'`. For OAuth2, set `Configuration.username` (client ID) and `Configuration.password` (client secret). Using environment variables for sensitive credentials like `os.environ.get('DROPBOX_SIGN_API_KEY')` is highly recommended.
gotcha API errors are raised as `ApiException`. Catching generic `Exception` might mask specific API response issues.
Fix: Always catch `dropbox_sign.exceptions.ApiException` for API-specific errors. This allows you to inspect `e.status`, `e.reason`, and `e.body` for detailed error information returned by the Dropbox Sign API.

Install

pip install dropbox-sign Install stable version

Imports

Configuration
```
from dropbox_sign import Configuration
```
The package name and module paths changed significantly from 'hellosign-sdk' to 'dropbox-sign'.
ApiClient
```
from dropbox_sign import ApiClient
```
The core API client class now resides under the 'dropbox_sign' namespace.
account_api
```
from dropbox_sign.apis import account_api
```
Specific API modules are now located within the 'dropbox_sign.apis' subpackage.
ApiException
```
from dropbox_sign.exceptions import ApiException
```
Specific exceptions like ApiException for API errors are found here.

Quickstart

This quickstart demonstrates how to initialize the Dropbox Sign client using an API key from an environment variable, fetch basic account information, and handle potential API errors. Replace `DROPBOX_SIGN_API_KEY` with your actual API key.

import os
from dropbox_sign import Configuration, ApiClient
from dropbox_sign.apis import account_api
from dropbox_sign.exceptions import ApiException

# It's recommended to load your API key from environment variables
api_key = os.environ.get('DROPBOX_SIGN_API_KEY', '')

if not api_key:
    print("Warning: DROPBOX_SIGN_API_KEY environment variable not set. "
          "This example will likely fail. Please set it for a successful run.")

# Configure API key authorization
configuration = Configuration(api_key=api_key)

try:
    # Create an API client instance
    with ApiClient(configuration) as api_client:
        # Instantiate a specific API (e.g., AccountApi) with the client
        account_api_instance = account_api.AccountApi(api_client)
        
        # Call an API method, e.g., get the current account information
        response = account_api_instance.account_get()
        
        print("Successfully retrieved account information:")
        print(response.to_dict()) # Convert response model to dictionary for easy printing
        
except ApiException as e:
    print(f"Error calling Dropbox Sign API: Status {e.status}, Reason {e.reason}, Body {e.body}")
except Exception as e:
    print(f"An unexpected error occurred: {e}")

view raw JSON →