Python SharePoint Online Connector In this article you will learn how to integrate SharePoint Online data to Python (live / bi-directional connection to SharePoint Online). SharePoint Connector can be used to integrate SharePoint and your defined data source, e.g. Microsoft SQL, Oracle, Excel, Power BI, etc. Get, write, delete SharePoint data in a few clicks!. Using SharePoint Online 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  Help File  Buy  Driver mentioned in this article 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. ODBC PowerPack - System Requirements and Installation Getting Started - Using ODBC PowerPack ODBC API Driver Help File

See also Connect SharePoint Online in SSIS Connect SharePoint Online in SQL Server Connect SharePoint Online in Power BI Connect SharePoint Online in SSRS Connect SharePoint Online in Informatica Connect SharePoint Online in MS Access Connect SharePoint Online in MS Excel Connect SharePoint Online in SSAS Connect SharePoint Online in C# Connect SharePoint Online in JAVA Connect SharePoint Online in Tableau Connect SharePoint Online in SAP Crystal Reports Connect SharePoint Online in Azure Data Factory (ADF) Connect SharePoint Online in ODBC

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

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

1. Install ZappySys ODBC PowerPack.

2. Open ODBC Data Sources (x64):
   

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

4. When the Configuration window appears give your data source a name if you haven't done that already, then select "SharePoint Online" from the list of Popular Connectors. If "SharePoint Online" 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:

   SharePointOnlineDSN

   SharePoint Online

   

5. 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 Credentials [OAuth]

   OAuth App must be created in Microsoft Azure AD. These settings typically found here https://docs.microsoft.com/en-us/graph/auth-register-app-v2. [Read more..]

   Steps to get SharePoint Online 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 Sites.Read.All Sites.ReadWrite.All User.Read email
   15. Click Generate Token to generate tokens.
   16. That's it!

   For more information you can read this link https://docs.microsoft.com/en-us/graph/auth-register-app-v2 Also https://docs.microsoft.com/en-us/graph/auth-register-app-v2

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

   SharePointOnlineDSN

   SharePoint Online

   User Credentials [OAuth]

   https://graph.microsoft.com/v1.0

   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...
   SiteId (Select after Generate Token)	Fill in the parameter...
   Optional Parameters
   Client Secret	Fill in the parameter...
   ReturnUrl	Fill in the parameter...
   Login Prompt Option	Fill in the parameter...
   RetryMode	Fill in the parameter...
   RetryStatusCodeList	Fill in the parameter...
   RetryCountMax	Fill in the parameter...
   RetryMultiplyWaitTime	Fill in the parameter...

   

    Application Credentials [OAuth]

   OAuth App must be created in Microsoft Azure AD. These settings typically found here https://docs.microsoft.com/en-us/graph/auth-v2-service [Read more..]

   Steps to get SharePoint Online 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. Copy Application (client) ID and paste it into API Connection Manager configuration grid in Client ID row.
   9. Then click on Endpoints link and copy second, Token, URL to Token URL field in configuration grid. Usually they look similar to these:
      • https://login.microsoftonline.com/daed1250-xxxx-xxxx-xxxx-ef0a982d3d1e/oauth2/v2.0/token
      • https://login.microsoftonline.com/common/oauth2/v2.0/token
   10. Close "Endpoints" and create a Client Secret by clicking Certificates & secrets.
   11. Proceed by clicking New client secret and setting expiration period. Copy the client secret and paste it into configuration grid in Client Secret row.
   12. Go to API Permissions section and add Microsoft Graph permissions for SharePoint and Drive, e.g. Sites.Selected, Sites.Read.All, Sites.ReadWrite.All, Files.Read.All, Files.ReadWrite.All.
   13. Finally, Grant admin consent for your domain for your permissions.
   14. That's it!

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

   SharePointOnlineDSN

   SharePoint Online

   Application Credentials [OAuth]

   https://graph.microsoft.com/v1.0

   Required Parameters
   Token URL	Fill in the parameter...
   Client ID	Fill in the parameter...
   Client Secret	Fill in the parameter...
   SiteId	Fill in the parameter...
   Optional Parameters
   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...

   

6. 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:
   

7. Click OK to finish creating the data source.

Read data in Python from the DSN

1. Python code to get the data:
   

   SharePointOnlineDSN')

   

2. When you run the code it will make the API call and read the data:
   

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

   
   import pyodbc
   
   conn = pyodbc.connect('DSN=SharePointOnlineDSN')
   
   cursor = conn.cursor() 
   
   #execute query to fetch data from API service
   cursor.execute("SELECT * FROM value") 
   row = cursor.fetchone() 
   while row: 
   print (row[1]) 
   row = cursor.fetchone()
   

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 Python code use Connection String when initializing OdbcConnection object, for example:

   conn = pyodbc.connect('DRIVER={ZappySys API Driver};ServiceUrl=https://services.odata.org/V3/Northwind/Northwind.svc;Provider=OData;AuthName=Http;')
   

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:
   

2. Enter the desired Procedure name and click on OK:
   

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>>'
    AS
       SELECT * FROM Orders where OrderDate >= '<@fromdate>';
   

   
   

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';

   
   

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:
   

2. Enter the desired Table name and click on OK:
   

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
   

   SELECT
     "ShipCountry",
     "OrderID",
     "CustomerID",
     "EmployeeID",
     "OrderDate",
     "RequiredDate",
     "ShippedDate",
     "ShipVia",
     "Freight",
     "ShipName",
     "ShipAddress",
     "ShipCity",
     "ShipRegion",
     "ShipPostalCode"
   FROM "Orders"
   Where "ShipCountry"='USA'

   
   

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"

   
   

Conclusion

Download SharePoint Online Connector for Python Documentation 

Actions supported by SharePoint Online Connector

Other App Integration scenarios for SharePoint Online

SSIS

SQL Server

Power BI

SSRS

Informatica

MS Access

MS Excel

SSAS

C#

JAVA

Tableau

SAP Crystal Reports

Azure Data Factory (ADF)

ODBC

Other Connectors for Python

Zendesk

ManagedEngine ServiceDesk Plus (Zoho)

Zoho CRM

Hubspot

Google Sheets

Stripe

YouTube

Google BigQuery

OneDrive

OData

Amazon Ads

Jira

Zoom

Nativo

Google Drive

SharePoint Online

Amazon MWS

ElasticSearch

Google Calendar

DropBox

REST API

JSON

JSON File

XML

SOAP

XML File

JDBC-ODBC Bridge

Salesforce

CSV

Download SharePoint Online Connector for Python Documentation 

Common Searches: