C# OneDrive API Connector

In this article you will learn, how to integrate OneDrive data to C# without coding in few clicks (Live / Bi-directional connection to OneDrive). OneDrive Connector can be used to integrate OneDrive and your defined data source, e.g. Microsoft SQL, Oracle, Excel, Power BI, etc. Get, write, delete OneDrive data in a few clicks!

Using OneDrive API Connector you will be able to connect, read and write data from within C#. Let's take a look at the steps below to see how exactly to accomplish that.

Download  Help File  Buy 

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

To get data from OneDrive using C# we first need to create a DSN - Data Source - which will access data from OneDrive, which later will be able to get using C#. Perform these steps:

  1. Install ZappySys ODBC PowerPack.

  2. Open ODBC Data Sources (x64):
    Open ODBC Data Source

  3. Create a User Data Source (User DSN) based on ZappySys API Driver:

    Create new API Connection for OneDrive

    You should create System DSN if client application is launched under Windows System Account, e.g. as a Windows Service.
    Launch ODBC Data Sources 32-bit version in case your client application is a 32-bit (x86) application (required only for System DSN).
  4. When a window appears, firstly give your data source a name if you haven't done that already, then select "OneDrive" from the list of Popular Connectors. If "OneDrive" is not present in the list, then click "Search Online" and download it. Then set the path to the one where you downloaded it. Finally, hit Continue >> button to continue configuring DSN:

    ODBC DSN Template Selection

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

    Steps to get OneDrive Credentials

    Firstly, login into Azure Portal and there create an OAuth application:

    1. Go to Azure Portal and login there.
    2. Then go to Azure Active Directory.
    3. On the left side click menu item App registrations
    4. Then proceed with clicking New registration.
    5. Enter a name for your application.
    6. Select one of Accounts in this organizational directory only as supported account type to access data in your company.
    7. In Redirect URI section leave option selected at Web.
    8. In nearby textbox enter https://login.microsoftonline.com/common/oauth2/nativeclient as Redirect URI or any other valid redirect URL, e.g. https://zappysys.com/oauth
    9. Use this Redirect URI in Redirect URL grid row.
    10. Copy Application (client) ID and paste it into API Connection Manager configuration grid in Client ID row.
    11. Then click on Endpoints link and copy first URL to Authorization URL and second one to Token URL in configuration grid. Usually they look similar to these:
      • https://login.microsoftonline.com/daed1250-xxxx-xxxx-xxxx-ef0a982d3d1e/oauth2/v2.0/authorize
      • https://login.microsoftonline.com/daed1250-xxxx-xxxx-xxxx-ef0a982d3d1e/oauth2/v2.0/token
      • https://login.microsoftonline.com/common/oauth2/v2.0/authorize
      • https://login.microsoftonline.com/common/oauth2/v2.0/token
    12. Close "Endpoints" and create a Client Secret by clicking Certificates & secrets.
    13. Proceed by clicking New client secret and setting expiration period. Copy the client secret and paste it into configuration grid in Client Secret row.
    14. Use these scopes in Scopes field: offline_access Files.Read Files.Read.All Files.ReadWrite Files.ReadWrite.All openid profile User.Read email
    15. Click Generate Token to generate tokens.
    16. That's it!

    API Reference (External Site)

    And finally, fill in all the required parameters and set optional parameters if needed.:

    User Credentials [OAuth]
    Required Parameters
    Authorization URL Fill in the parameter...
    Token URL Fill in the parameter...
    Client ID Fill in the parameter...
    Scope Fill in the parameter...
    Optional Parameters
    Client Secret Fill in the parameter...
    Refresh Token File Path Fill in the parameter...
    ReturnUrl Fill in the parameter...
    RetryMode Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    Login Prompt Option Fill in the parameter...
    ODBC DSN Oauth Connection Configuration

  6. Once you configured a data source, you can preview data. Hit Preview tab, and use similar settings to preview data:
    ODBC ZappySys Data Source Preview

  7. Click OK to finish creating the data source

Read data in C# from the DSN

  1. Create a fresh new Console project and use this code to get the data:

    Make ZappySys Driver call in c#

  2. Hit F5 to run the code and read the data:
    ZappySys Driver Output in c#

  3. Here is program's code in text format:

    using System;
    using System.Data.Odbc;
    namespace ConsoleApp {
        class Program {
            static void Main() {
                var dsn = "OneDriveDSN";
                using (var conn = new OdbcConnection(String.Format("DSN={0}", dsn)))
                    var cmd = new OdbcCommand("SELECT * FROM Products", conn);
                    var rdr = cmd.ExecuteReader();
                    while (rdr.Read())
                        for (int i = 0; i < rdr.FieldCount; i++)
                                Console.Write("{0}\t", rdr[i]);

  4. If you want to avoid to be dependent on a DSN name 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 . Then in your C# code use Connection String when initializing OdbcConnection object, for example:

    using (var conn = new OdbcConnection("DRIVER={ZappySys API Driver};ServiceUrl=https://services.odata.org/V3/Northwind/Northwind.svc;Provider=OData;AuthName=Http;"))
         // ...

    How to overcome long ConnectionString Issue?

    If you copy ConnectionString from UI and if you have long RefreshToken=xxxxxxxxxxxxxxxxxx...xxx, very long more than 1000 chars. It can cause the issue.

    To overcome from a such issue you can supply RefreshToken via file actually. You just need to cut the RefreshToken and paste it in some text file and save it and pass that file path instead of the RefreshToken.

    using (var conn = new OdbcConnection("Driver={ZappySys API Driver};RefreshToken=xxxxxx...xxx;ServiceUrl=xxx...;"))
         // ...

    You can use that file path in the ConnectionString, remove the RefreshToken=xxxxxx...xxx; attribute from the ConnectionString and you can pass RefreshTokenFile=c:\my_refresh_token.txt;

    using (var conn = new OdbcConnection("Driver={ZappySys API Driver};RefreshTokenFile={{YourRefreshTokenFilePath}};ServiceUrl=...;"))
         // ...

Create Custom Store 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 Store Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

  1. Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
    ZappySys Driver - Add Store Procedure

  2. Enter the desired Procedure name and click on OK:
    ZappySys Driver - Add Store Procedure Name

  3. Select the created Store Procedure and write the your desired store procedure and Save it and it will create the custom store 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>>'
        SELECT * FROM Orders where OrderDate >= '<@fromdate>';

    ZappySys Driver - Create Custom Store Procedure

  4. That's it now go to Preview Tab and Execute your Store 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';

    ZappySys Driver - Execute Custom Store Procedure

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.

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.

  1. Go to Custom Objects Tab and Click on Add button and Select Add Table:
    ZappySys Driver - Add Table

  2. Enter the desired Table name and click on OK:
    ZappySys Driver - Add Table Name

  3. And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.

  4. 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

    FROM "Orders"
    Where "ShipCountry"='USA'

    ZappySys Driver - Create Custom Table

  5. 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"

    ZappySys Driver - Execute Custom Virtual Table Query


In this article we discussed how to connect to OneDrive in C# and integrate data without any coding. Click here to Download OneDrive Connector for C# 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).


Actions supported by OneDrive Connector

OneDrive Connectors 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.
 List Drives
 Read Drive
Parameter Description
DriveId Specify a drive
 List Root
Parameter Description
DriveId Specify a drive
 Lists Folder
Parameter Description
DriveId Specify a drive
FolderId Specify a folder
 List Excel Files
Parameter Description
DriveId Specify a drive
 List Excel Worksheets
Parameter Description
DriveId Specify a drive Id to search items in
FileId Specify a drive Id to search items in
 Read Excel Worksheet
Parameter Description
DriveId Specify a drive Id
FileId Specify a file id
SheetId Specify a sheet name
 Download File
Parameter Description
DriveId Specify a drive Id
FileId Specify a file id
 Upload File
Don't forget to set up
Parameter Description
DriveId Specify a drive Id
SourceFilePath Specify a disk file path
TargetFilePath Specify Target file path
 Delete Item
Parameter Description
DriveId Specify a drive Id
ItemId Specify a drive Id
 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.
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 Check 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. 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

Other App Integration scenarios for OneDrive

Other API Connectors for C#


  • How to connect OneDrive in C#?

  • How to get OneDrive data in C#?

  • How to read OneDrive data in C#?

  • How to load OneDrive data in C#?

  • How to import OneDrive data in C#?

  • How to pull OneDrive data in C#?

  • How to push data to OneDrive in C#?

  • How to write data to OneDrive in C#?

  • How to POST data to OneDrive in C#?

  • Call OneDrive API in C#

  • Consume OneDrive API in C#

  • OneDrive C# Automate

  • OneDrive C# Integration

  • Integration OneDrive in C#

  • Consume real-time OneDrive data in C#

  • Consume realtime OneDrive API data in C#

  • OneDrive ODBC Driver | ODBC Driver for OneDrive | ODBC OneDrive Driver | SSIS OneDrive Source | SSIS OneDrive Destination

  • Connect OneDrive in C#

  • Load OneDrive in C#

  • Load OneDrive data in C#

  • Read OneDrive data in C#

  • OneDrive API Call in C#