DropBox Connector for Python

In this article you will learn how to integrate DropBox data in Python (live / bi-directional connection to DropBox). Read / write DropBox data inside your app; perform many DropBox operations without coding, just use easy to use high performance API Connector for DropBox.

Using DropBox Connector you will be able to connect, read, and write data from within Python. Follow the steps below to see how we would accomplish that.

Download Documentation

The driver mentioned above is part of ODBC PowerPack which is a collection of high-performance Drivers for various API data source (i.e. REST API, JSON, XML, CSV, Amazon S3 and many more). Using familiar SQL query language you can make live connections and read/write data from API sources or JSON / XML / CSV Files inside SQL Server (T-SQL) or your favorite Reporting (i.e. Power BI, Tableau, Qlik, SSRS, MicroStrategy, Excel, MS Access), ETL Tools (i.e. Informatica, Talend, Pentaho, SSIS). You can also call our drivers from programming languages such as JAVA, C#, Python, PowerShell etc.

If you are new to ODBC and ZappySys ODBC PowerPack then check the following links to get started.

Connect to DropBox in other apps

Connect to DropBox in SSIS

Connect to DropBox in SQL Server

Connect to DropBox in Power BI

Connect to DropBox in SSRS

Connect to DropBox in Informatica

Connect to DropBox in MS Access

Connect to DropBox in MS Excel

Connect to DropBox in SSAS

Connect to DropBox in C#

Connect to DropBox in JAVA

Connect to DropBox in Tableau

Connect to DropBox in SAP Crystal Reports

Connect to DropBox in Azure Data Factory (Pipeline)

Connect to DropBox in Azure Data Factory (SSIS)

Connect to DropBox in Talend Studio

Connect to DropBox in UiPath

Connect to DropBox in PowerShell

Connect to DropBox in ODBC

Create ODBC Data Source (DSN) based on ZappySys API Driver

Step-by-step instructions

To get data from DropBox using Python we first need to create a DSN (Data Source) which will access data from DropBox. We will later be able to read data using Python. Perform these steps:

Install ZappySys ODBC PowerPack.
Open ODBC Data Sources (x64):
Create a User Data Source (User DSN) based on ZappySys API Driver

ZappySys API Driver

You should create a System DSN (instead of a User DSN) if the client application is launched under a Windows System Account, e.g. as a Windows Service. If the client application is 32-bit (x86) running with a System DSN, use ODBC Data Sources (32-bit) instead of the 64-bit version.
When the Configuration window appears give your data source a name if you haven't done that already, then select "DropBox" from the list of Popular Connectors. If "DropBox" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:

DropBoxDSN

DropBox

Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.

User Account [OAuth]

Steps to get DropBox Credentials : User Account [OAuth]

To use OAuth authentication, firstly, you need to create OAuth application:

Log into your DropBox account.
Go to https://www.dropbox.com/developers/apps.
Press Create app button to create a new app.
Once a new page opens, select Scoped access option.
Next, select Full Dropbox to access all files and folders or App folder to access specific folder's files and folders option
Give your app a name
Click create app
Once a new page opens, click Scoped App in Permission type line to select application scopes.
Select all Individual Scopes and Team Scopes if you want to manage team data. Click Submit button.
Select Settings tab, scroll down to App key and App secret and copy paste them into Notepad.
Then in OAuth 2 section add a URL as Redirect URI. If you don't have a working Redirect URI, you may add https://zappysys.com/oauth as Redirect URI

Use App key and App secret and Redirect URI for use in Connection String when connecting or in UI.

NOTE: If you are planning to use your current data connection/token for automated processes, we recommend that you use a generic account for token generation when the login box appears (e.g. sales_automation@mycompany.com instead of bob_smith@mycompany.com). When you use a personal account which is tied to a specific employee profile and that employee leaves the company, the token may become invalid and any automated processes using that token will fail. Another potentially unwanted effect of using a personal token is incorrect logging; the API calls (e.g. Read, Edit, Delete, Upload) made with that token will record the specific user as performing the calls instead of an automated process.

Fill in all required parameters and set optional parameters if needed:

DropBoxDSN

DropBox

User Account [OAuth]

https://api.dropboxapi.com/2/

Required Parameters
UseCustomApp	Fill in the parameter...
ReturnUrl	Fill in the parameter...
Optional Parameters
ClientId	Fill in the parameter...
ClientSecret	Fill in the parameter...
Scope	Fill in the parameter...
RetryMode	Fill in the parameter...
RetryStatusCodeList	Fill in the parameter...
RetryCountMax	Fill in the parameter...
RetryMultiplyWaitTime	Fill in the parameter...

Once the data source has been configured, you can preview data. Select the Preview tab and use settings similar to the following to preview data:
Click OK to finish creating the data source.

Video instructions

Watch this video on YouTube

Read data in Python

Using ODBC DSN

Python code to get the data:

DropBoxDSN')
When you run the code it will make the API call and read the data:

Here is Python program's code in text format:


    import pyodbc
    conn = pyodbc.connect('DSN=DropBoxDSN')

    cursor = conn.cursor()

    #execute query to fetch data from API service
    cursor.execute("SELECT id,title FROM products")

    row = cursor.fetchone()
    while row:
        print(row)
        row = cursor.fetchone()

    ##For loop example
    #for row in cursor:
    #    print(row)

Using a full ODBC connection string

If you want to avoid being dependent on a DSN and creating multiple DSNs for each platform (x86, x64), then you can use a fully qualified connection string. Simply go to your DSN and copy the Connection String:

Open ODBC data source configuration and click Copy settings:

ZappySys API Driver - DropBox

Read / write DropBox data inside your app; perform many DropBox operations without coding, just use easy to use high performance API Connector for DropBox

DropBoxDSN
The window opens, telling us the connection string was successfully copied to the clipboard:

Then in your Python code use Connection String when initializing OdbcConnection object, for example:

conn = pyodbc.connect('DRIVER={ZappySys API Driver};ServiceUrl=https://yourservices.provider.com/api/xxxx....;AuthName=Http;')

How to install `pyodbc` in the Python?

You would need to install pyodbc in Python if you intend to establish connections to databases that support ODBC (Open Database Connectivity). This module facilitates communication between Python applications and various database management systems, enabling you to perform operations such as querying, retrieving data, and managing databases. Here's how you can install pyodbc in Python:

Installation Steps:

Ensure you have Python installed on your system. If not, download it from the official Python website and follow the installation instructions.
Open your terminal or command prompt.
Use the following command to install pyodbc using pip, the Python package installer:
```
python -m pip install "pyodbc"
```
Make sure you have a stable internet connection and the necessary permissions to install Python packages.

Reasons to Install:

If pyodbc is not installed, your Python script will generate the following error:
```
"ModuleNotFoundError: No module named 'pyodbc'"
```
.
Database Connectivity: pyodbc allows Python to connect to various databases that support ODBC, such as Microsoft SQL Server, PostgreSQL, MySQL, and more.
Data Operations: It facilitates the execution of SQL queries, retrieval of data, and other database operations from within Python scripts.
Cross-Platform Support: pyodbc is designed to work across different operating systems, including Windows, macOS, and various Linux distributions.
Simplicity and Efficiency: The module provides an intuitive interface for managing database transactions and connections, simplifying the process of working with databases in Python.

By installing pyodbc, you can seamlessly integrate your Python applications with a wide range of ODBC-supported databases, enabling efficient and effective data management and analysis.

Advanced topics

Create Custom Stored Procedure in ZappySys Driver

You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.

Steps to create Custom Stored Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
Enter the desired Procedure name and click on OK:
Select the created Stored Procedure and write the your desired stored procedure and Save it and it will create the custom stored procedure in the ZappySys Driver:
Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
```
CREATE PROCEDURE [usp_get_orders]
    @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>'
 AS
    SELECT * FROM Orders where OrderDate >= '<@fromdate>';
```
That's it now go to Preview Tab and Execute your Stored Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:
```
Exec usp_get_orders '1996-01-01';
```
Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
```
SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC usp_get_orders @fromdate=''1996-07-30''')
```
Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.

Create Custom Virtual Table in ZappySys Driver

ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.

If you're dealing with Microsoft Access and need to import data from an SQL query, it's important to note that Access doesn't allow direct import of SQL queries. Instead, you can create custom objects (Virtual Tables) to handle the import process.

Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.

Go to Custom Objects Tab and Click on Add button and Select Add Table:
Enter the desired Table name and click on OK:
And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.
Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here
```
SELECT
  "ShipCountry",
  "OrderID",
  "CustomerID",
  "EmployeeID",
  "OrderDate",
  "RequiredDate",
  "ShippedDate",
  "ShipVia",
  "Freight",
  "ShipName",
  "ShipAddress",
  "ShipCity",
  "ShipRegion",
  "ShipPostalCode"
FROM "Orders"
Where "ShipCountry"='USA'
```
That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:
```
SELECT * FROM "vt__usa_orders_only"
```
Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
```
SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')
```
Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.

Actions supported by DropBox Connector

DropBox Connector support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.

Make connection test

Makes a connection test [Read more...]

List folder

Lists folder [Read more...]

Parameter

Description

Path

Recursive

Option	Value
true	true
false	false

Download a file

Downloads a file [Read more...]

Parameter	Description
SourceFilePath

Download a folder and folders/files within as ZIP archive

Downloads a folder with all the files and folders it contains as ZIP file [Read more...]

Parameter	Description
SourcePath

Upload a file

Upload a file [Read more...]

Parameter	Description
TargetFilePath	Specify a file path in DropBox to save file to
SourceFilePath	Specify a disk file path to upload

Create folder

Creates folder [Read more...]

Parameter	Description
Path

Delete

Deletes file or folder [Read more...]

Parameter	Description
Path

Generic Request

This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL. [Read more...]

Parameter	Description
Url	API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains
Body	Request Body content goes here
IsMultiPart	Set this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value) ==== Raw Upload (Content-Type: application/octet-stream) ===== To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip ) ==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) ===== To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored. If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type. See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored). file1=@c:\data\Myfile1.txt file2=@c:\data\Myfile2.json file2.Content-Type=application/json SomeField1=aaaaaaa SomeField1.Content-Type=text/plain SomeField2=12345 SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab SomeFieldStartingWithAtSign=\@MyTwitterHandle
Filter	Enter filter to extract array from response. Example: $.rows[] --OR-- $.customers[].orders[*]. Check your response document and find out hierarchy you like to extract
Headers	Headers for Request. To enter multiple headers use double pipe or new line after each {header-name}:{value} pair

DropBox Connector Examples for Python Connection

This page offers a collection of SQL examples designed for seamless integration with the ZappySys API ODBC Driver under ODBC Data Source (36/64) or ZappySys Data Gateway, enhancing your ability to connect and interact with Prebuilt Connectors effectively.

Test connection [Read more...]

Tests connection

SELECT *
  FROM make_test

List folder #1 [Read more...]

Lists all files and folders within a folder

SELECT *
  FROM list_folder

List folder #2 [Read more...]

Lists all files and folders within a folder

SELECT *
  FROM list_folder
  WITH (Path='/MySubfolder'
       ,Recursive='true')

Download file [Read more...]

Downloads a file

SELECT *
  FROM download_file
  WITH (SourceFilePath='/file-I-want-to-download.dat'
        ,ResponseDataFile='C:\path\I\want\to\save\my\file\to.dat'
      )

Download folder as ZIP file [Read more...]

Downloads a folder with all files and folders within it as ZIP file

SELECT *
  FROM download_folder
  WITH (SourcePath='/folder-I-want-to-download'
        ,ResponseDataFile='C:\path\I\want\to\save\my\folder\to.zip'
      )

Upload a file [Read more...]

Uploads a file

SELECT *
  FROM upload_file
  WITH (TargetFilePath='/MySubfolder/file-I-want-to-upload-to-dropbox.dat'
        ,DiskFilePath='C:\file\I\want\to\upload.dat'
      )

Delete a file or a folder [Read more...]

Deletes a file or a folder

SELECT *
  FROM delete
  WITH (Path='/path/to/file/in/dropbox/I/want/to/delete.dat')

Create a folder [Read more...]

Creates a folder

SELECT *
  FROM create_folder
  WITH (Path='/folder/in/dropbox/I/want/to/create')

Conclusion

In this article we discussed how to connect to DropBox in Python and integrate data without any coding. Click here to Download DropBox Connector for Python and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).

Download DropBox Connector for Python Documentation

More integrations

Other application integration scenarios for DropBox

SSIS

SQL Server

Power BI

SSRS

Informatica

MS Access

MS Excel

SSAS

JAVA

Tableau

SAP Crystal Reports

Azure Data Factory (Pipeline)

Azure Data Factory (SSIS)

Talend Studio

UiPath

PowerShell

ODBC

Other connectors for Python

Amazon Ads

Amazon MWS

Amazon Selling Partner (SP-API)

Asana

Azure DevOps

Cosmos DB

DropBox

FastSpring

Google Drive

Hubspot

Jira

Mailchimp

ManagedEngine ServiceDesk Plus (Zoho)

Nativo

OData

OneDrive

Outlook Mail (Office 365)

Power BI

ServiceNow

SharePoint Online

Shopify

Smartsheet

Stripe

YouTube

Zendesk

Zoho CRM

Zoho SalesIQ

Zoom

REST API

JSON

JSON File

XML

SOAP

XML File

JDBC-ODBC Bridge

Salesforce

CSV

Amazon S3 JSON File

Amazon S3 XML File

Amazon S3 CSV File

Azure Blob JSON File

Azure Blob XML File

Azure Blob CSV File

FTP/SFTP JSON File

FTP/SFTP XML File

FTP/SFTP CSV File

Build your own Custom API Connector

Download DropBox Connector for Python Documentation

Common Searches:

How to connect DropBox in Python?
How to get DropBox data in Python?
How to read DropBox data in Python?
How to load DropBox data in Python?
How to import DropBox data in Python?
How to pull DropBox data in Python?
How to push data to DropBox in Python?
How to write data to DropBox in Python?
How to POST data to DropBox in Python?
Call DropBox API in Python
Consume DropBox API in Python
DropBox Python Automate
DropBox Python Integration
Integration DropBox in Python
Consume real-time DropBox data in Python
Consume real-time DropBox API data in Python
DropBox ODBC Driver | ODBC Driver for DropBox | ODBC DropBox Driver | SSIS DropBox Source | SSIS DropBox Destination
Connect DropBox in Python
Load DropBox in Python
Load DropBox data in Python
Read DropBox data in Python
DropBox API Call in Python