Asana Connector for Python
In this article you will learn how to integrate Using Asana 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. 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 Asana in other apps
|
Create ODBC Data Source (DSN) based on ZappySys API Driver
Step-by-step instructions
To get data from Asana using Python we first need to create a DSN (Data Source) which will access data from Asana. 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 DriverYou 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 "Asana" from the list of Popular Connectors. If "Asana" 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:
AsanaDSNAsana -
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.
Steps to get Asana Credentials
Here is how to obtain PAT (Personal Access Token). .- Follow this link and click to Create new token.
- Once token generated copy it enter in Token field on this UI. Treat Token like a Password, keep it secure.
Fill in all required parameters and set optional parameters if needed:
AsanaDSNAsanaToken [Http]https://app.asana.com/api/1.0Required Parameters Optional Parameters Enter Token (Personal Access Token - PAT) Fill in the parameter... Default Workspace (** Select after Token is entered **) Fill in the parameter... Default Project (** Select after Token is entered **) Fill in the parameter... RetryMode Fill in the parameter... RetryStatusCodeList Fill in the parameter... RetryCountMax Fill in the parameter... RetryMultiplyWaitTime Fill in the parameter... Steps to get Asana Credentials
Here is how to register OAuth App.- Follow this link and click to Create new app under My Apps.
- Give your app a name e.g. My Integration. Check one of the options | Check I Agree | Click Create app
- Copy Client Id and Secret. Keep it secure, we will use it later on API Connection UI.
- Click on the OAuth section (Under Configure) on your left. Under the Redirect URLs Click [Add redirect URL] button. Enter URL like this https://zappysys.com/oauth. Do not use any random URL otherwise it may not work.
- Click on the Manage distribution section (Under Test & distribute) on your left. Here you can add specific workspaces you like to access using this App. If you like to access any workspace then choose [Any workspace] option
- Click [Save changes] button. Might be located all the way bottom right on your screen.
- Now go back to connection UI and enter ClientId, Client Secret and Redirect URL (match exactly).
- Click Generate Token and follow the login prompts. If everything goes well you will see Refresh Token generated.
- Choose Default Workspace and Default Project.
- Click Test connection to confirm. Now you are ready to use this connection.
Fill in all required parameters and set optional parameters if needed:
AsanaDSNAsanaOAuth [OAuth]https://app.asana.com/api/1.0Required Parameters ClientId Fill in the parameter... Client Secret Fill in the parameter... Optional Parameters Permissions Fill in the parameter... Redirect URL Fill in the parameter... Default Workspace (** Select after Token is generated **) Fill in the parameter... Default Project (** Select after Token is generated **) 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
Read data in Python
Using ODBC DSN
-
Python code to get the data:
AsanaDSN') -
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=AsanaDSN') 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 - AsanaRead and write data related to Tasks, Projects, Workspaces, Portfolios, TimeEntries, Memberships and more.AsanaDSN
- 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 Asana Connector
Asana 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.Parameter | Description |
---|---|
Workspace Id |
|
Parameter | Description |
---|---|
Workspace Id |
|
Team Id |
|
Parameter | Description |
---|---|
Project Id |
|
Parameter | Description | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
QueryBy |
|
||||||||||||||||||||||||||||||||||||||
Project Id |
|
||||||||||||||||||||||||||||||||||||||
Workspace Id |
|
||||||||||||||||||||||||||||||||||||||
Assignee Id |
|
||||||||||||||||||||||||||||||||||||||
Section Id |
|
||||||||||||||||||||||||||||||||||||||
Tag Id |
|
||||||||||||||||||||||||||||||||||||||
UserTaskListId |
|
||||||||||||||||||||||||||||||||||||||
Completed Since |
|
||||||||||||||||||||||||||||||||||||||
Modified Since |
|
Parameter | Description |
---|---|
TaskId |
|
Parameter | Description |
---|---|
Workspace Id |
|
Parameter | Description |
---|---|
Project Id |
|
Parameter | Description |
---|---|
Project Id |
|
Section Id |
|
Parameter | Description |
---|---|
User Id |
|
Parameter | Description |
---|---|
Workspace Id |
|
Project Id |
|
User Id |
|
Parameter | Description |
---|---|
Parent Id (e.g. Id of Project, Task or ProjectBrief) |
|
Parameter | Description | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Attachment ID |
|
||||||||||||||||||||||||||
Fields |
|
Parameter | Description | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parent Id (e.g. Id of Project, Task or ProjectBrief) |
|
||||||||||||||||||||||||||
OverwriteFile |
|
||||||||||||||||||||||||||
SaveFolder |
|
||||||||||||||||||||||||||
Fields |
|
Parameter | Description |
---|---|
Workspace Id |
|
Owner Id |
|
Parameter | Description | ||||||
---|---|---|---|---|---|---|---|
Workspace Id |
|
||||||
Project Id |
|
||||||
Portfolio Id |
|
||||||
Team Id |
|
||||||
Is Workspace Level |
|
||||||
Time Periods (e.g. Id1,Id2) |
|
Parameter | Description |
---|---|
Workspace Id |
|
Parameter | Description |
---|---|
Project Id |
|
Parameter | Description |
---|---|
Portfolio Id |
|
Parameter | Description |
---|---|
User Id |
|
Workspace Id |
|
Parameter | Description |
---|---|
Project Id |
|
PortfolioId |
|
GoalId |
|
Member or Team Id (Use with Project OR Portfolio OR Goal) |
|
Parameter | Description |
---|---|
Task Id |
|
Parameter | Description |
---|---|
Url |
|
Body |
|
IsMultiPart |
|
Filter |
|
Headers |
|
Asana 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.
Read Workspaces [Read more...]
Read all workspaces
SELECT * FROM Workspaces
Read Projects [Read more...]
Read all projects
SELECT * FROM Projects
Read Tasks (default project) [Read more...]
Read all tasks (default project)
SELECT * FROM Tasks
Read Tasks for a specific project [Read more...]
Read all tasks for a specified project
SELECT * FROM Tasks WITH (ProjectId='1200652735638082')
Download Attachment to Local Disk [Read more...]
Download Attachment to Local Disk File.
SELECT * FROM download_attachment
WITH (
AttachmentId='1208216218258030'
, TargetFilePath='c:\temp\1208216218258030_AWS-refund-request.png'
, FileOverwriteMode=0 --0=AlwaysOverwrite, 1=FailIfExists, 2=SkipIfExists
)
Download Multiple Attachments to Local Disk [Read more...]
Download Multiple Attachments for a specified Parent (e.g. Task, Project, ProjectBrief) to Local Disk Folder. Saved file name syntax is {AttachmentId}_{FileName}.
SELECT * FROM download_attachments
WITH (
ParentId='1206673375982078' --Id of Task , Project or ProjectBrief
, SaveFolder='c:\temp'
, OverwriteFile=1
)
Read Portfolios for a specified Owner [Read more...]
Read Portfolios for a specified Owner (Default Workspace).
SELECT * FROM Portfolios WITH(OwnerId='1200442904128317')
Read Portfolios for a specified Owner and Workspace [Read more...]
Read Portfolios for a specified Owner Id and Workspace id.
SELECT * FROM Portfolios WITH(OwnerId='1200442904128317', WorkspaceId='1200442900140748')
Read Project Goals [Read more...]
Read Goals for a specified Project Id.
SELECT * FROM Goals WITH(Project='1206673375982078')
Read Workspace Goals [Read more...]
Read Goals for a specified Workspace Id.
SELECT * FROM Goals WITH(Workspace='1200442900140748')
Read Team Goals [Read more...]
Read Goals for a specified Team Id.
SELECT * FROM Goals WITH(Team='1200442900140748')
Read Memberships for a project [Read more...]
Read Memberships for a specific project.
SELECT * FROM Memberships WITH(ProjectId=1206673375982078)
Read Memberships for a project [Read more...]
Read Memberships for a specific project.
SELECT * FROM Memberships WITH(PortfolioId=1206673375982077)
Read Time Entries for a Task [Read more...]
Read Time Entries for a specific task.
SELECT * FROM TimeTrackingEntries WITH(TaskId=1207150837043133)
Conclusion
In this article we discussed how to connect to Asana in Python and integrate data without any coding. Click here to Download Asana 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 Asana Connector for Python
Documentation
More integrations
Other application integration scenarios for Asana
Other connectors for Python
Download Asana Connector for Python
Documentation
How to connect Asana in Python?
How to get Asana data in Python?
How to read Asana data in Python?
How to load Asana data in Python?
How to import Asana data in Python?
How to pull Asana data in Python?
How to push data to Asana in Python?
How to write data to Asana in Python?
How to POST data to Asana in Python?
Call Asana API in Python
Consume Asana API in Python
Asana Python Automate
Asana Python Integration
Integration Asana in Python
Consume real-time Asana data in Python
Consume real-time Asana API data in Python
Asana ODBC Driver | ODBC Driver for Asana | ODBC Asana Driver | SSIS Asana Source | SSIS Asana Destination
Connect Asana in Python
Load Asana in Python
Load Asana data in Python
Read Asana data in Python
Asana API Call in Python