DropBox Connector for Azure Data Factory (SSIS) How to Make Generic API Request
Prerequisites
Before we begin, make sure the following prerequisites are met:
- SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft).
- Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
- ODBC PowerPack is installed (if you are new to SSIS PowerPack, then get started!).
Make Generic API Request in SSIS
-
Begin with opening Visual Studio and Create a New Project.
-
Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.
In the new SSIS project screen you will find the following:
- SSIS ToolBox on left side bar
- Solution Explorer and Property Window on right bar
- Control flow, data flow, event Handlers, Package Explorer in tab windows
- Connection Manager Window in the bottom
Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link. -
Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.
-
From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:
-
Select New Connection to create a new connection:
-
Use a preinstalled DropBox Connector from Popular Connector List or press Search Online radio button to download DropBox Connector. Once downloaded simply use it in the configuration:
DropBox
-
Now it's time to configure authentication. Firstly, configure authentication settings in DropBox service and then proceed by configuring API Connection Manager. Start by expanding an authentication type:
DropBox authentication
To use OAuth authentication, firstly, you need to create OAuth application:
- Log into your DropBox account.
- Go to DropBox My Apps.
-
Then 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.
- Continue by giving your app a name.
- Then check I agree to Dropbox API Terms and Conditions checkbox.
- Click Create app button.
-
Once a new page opens, click Enable additional teams and Enable additional users buttons:
- Then copy App key and App secret and copy paste them into your favorite text editor (you will need them later).
-
Proceed by setting a Redirect URI and clicking Add button.
NOTE: If you don't have a working Redirect URI, you can use
https://zappysys.com/oauth(it's safe). -
Then click on Permissions tab and select application scopes:
- Select all Individual Scopes and Team Scopes if you want to manage team data.
- Click Submit button.
- Now go to SSIS package or ODBC data source and in User Account authentication set these parameters:
- For ClientId field use App key value.
- For ClientSecret field use App secret value.
- For ReturnUrl field use Redirect URI value.
- Done! Now you are ready to use Dropbox Connector!
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.API Connection Manager configuration
Just perform these simple steps to finish authentication configuration:
-
Set Authentication Type to
User Account [OAuth] - Optional step. Modify API Base URL if needed (in most cases default will work).
- Fill in all the required parameters and set optional parameters if needed.
- Press Generate Token button to generate the tokens.
- Finally, hit OK button:
DropBoxUser Account [OAuth]https://api.dropboxapi.com/2/Required Parameters UseCustomApp Fill-in the parameter... ReturnUrl Fill-in the parameter... Optional Parameters ClientId ClientSecret Scope RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 429 RetryCountMax 5 RetryMultiplyWaitTime True 
-
Select Generic Table (Bulk Read / Write) table from the dropdown and hit Preview Data:
API Source - DropBoxRead / write DropBox data inside your app; perform many DropBox operations without coding, just use easy to use high performance API Connector for DropBoxDropBoxGeneric Table (Bulk Read / Write)Required Parameters HTTP - Url or File Path Fill-in the parameter... HTTP - Request Method Fill-in the parameter... Optional Parameters HTTP - Request Body HTTP - Is MultiPart Body (Pass File data/Mixed Key/value) HTTP - Request Format (Content-Type) ApplicationJson HTTP - Headers (e.g. hdr1:aaa || hdr2:bbb) Accept: */* || Cache-Control: no-cache Parser - Response Format (Default=Json) Default Parser - Filter (e.g. $.rows[*] ) Parser - Encoding Parser - CharacterSet Download - Enable reading binary data False Download - File overwrite mode AlwaysOverwrite Download - Save file path Download - Enable raw output mode as single row False Download - Raw output data RowTemplate {Status:'Downloaded'} Download - Request Timeout (Milliseconds) General - Enable Custom Search/Replace General - SearchFor (e.g. (\d)-(\d)--regex) General - ReplaceWith (e.g. $1-***) General - File Compression Type General - Date Format General - Enable Big Number Handling False General - Wait time (Ms) - Helps to slow down pagination (Use for throttling) 0 JSON/XML - ExcludedProperties (e.g. meta,info) JSON/XML - Flatten Small Array (Not preferred for more than 10 items) JSON/XML - Max Array Items To Flatten 10 JSON/XML - Array Transform Type JSON/XML - Array Transform Column Name Filter JSON/XML - Array Transform Row Value Filter JSON/XML - Array Transform Enable Custom Columns JSON/XML - Enable Pivot Transform JSON/XML - Array Transform Custom Columns JSON/XML - Pivot Path Replace With JSON/XML - Enable Pivot Path Search Replace False JSON/XML - Pivot Path Search For JSON/XML - Include Pivot Path False JSON/XML - Throw Error When No Match for Filter False JSON/XML - Parent Column Prefix JSON/XML - Include Parent When Child Null False Pagination - Mode Pagination - Attribute Name (e.g. page) Pagination - Increment By (e.g. 100) 1 Pagination - Expression for Next URL (e.g. $.nextUrl) Pagination - Wait time after each request (milliseconds) 0 Pagination - Max Rows Expr Pagination - Max Pages Expr Pagination - Max Rows DataPath Expr Pagination - Max Pages 0 Pagination - End Rules Pagination - Next URL Suffix Pagination - Next URL End Indicator Pagination - Stop Indicator Expr Pagination - Current Page Pagination - End Strategy Type DetectBasedOnRecordCount Pagination - Stop based on this Response StatusCode Pagination - When EndStrategy Condition Equals True Pagination - Max Response Bytes 0 Pagination - Min Response Bytes 0 Pagination - Error String Match Pagination - Enable Page Token in Body False Pagination - Placeholders (e.g. {page}) Pagination - Has Different NextPage Info False Pagination - First Page Body Part Pagination - Next Page Body Part Csv - Column Delimiter , Csv - Has Header Row True Csv - Throw error when column count mismatch False Csv - Throw error when no record found False Csv - Allow comments (i.e. line starts with # treat as comment and skip line) False Csv - Comment Character # Csv - Skip rows 0 Csv - Ignore Blank Lines True Csv - Skip Empty Records False Csv - Skip Header Comment Rows 0 Csv - Trim Headers False Csv - Trim Fields False Csv - Ignore Quotes False Csv - Treat Any Blank Value As Null False Xml - ElementsToTreatAsArray 
-
That's it! We are done! Just in a few clicks we configured the call to DropBox using DropBox Connector.
You can load the source data into your desired destination using the Upsert Destination , which supports SQL Server, PostgreSQL, and Amazon Redshift. We also offer other destinations such as CSV , Excel , Azure Table , Salesforce , and more . You can check out our SSIS PowerPack Tasks and components for more options. (*loaded in Trash Destination)
More actions supported by DropBox Connector
Learn how to perform other actions directly in Azure Data Factory (SSIS) with these how-to guides:
- Create folder
- Delete
- Download a file
- Download a folder and folders/files within as ZIP archive
- List folder
- Make connection test
- Upload a file
- Make Generic API Request (Bulk Write)
