Learn more
 

Ready to get started?

Connect to live data from Todoist with the API Driver

Connect to Todoist

In this article

Related articles

Natively Connect to Todoist Data in PHP


The CData ODBC driver for Todoist enables you to create PHP applications with connectivity to Todoist data. Leverage the native support for ODBC in PHP.

Drop the CData ODBC Driver for Todoist into your LAMP or WAMP stack to build Todoist-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to Todoist data, execute queries, and output the results.

Configure a DSN

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

Start by setting the Profile connection property to the location of the Todoist Profile on disk (e.g. C:\profiles\Todoist.apip). Next, set the ProfileSettings connection property to the connection string for Todoist (see below).

Todoist API Profile Settings

To authenticate to Todoist, and connect to your own data or to allow other users to connect to their data, you can use the OAuth standard.

First, you will need to register an OAuth application with Todoist. To do so, go to App Management Console, create a new application and configure a valid OAuth redirect URL. Your Oauth application will be assigned a client id and a client secret.

After setting the following connection properties, you are ready to connect:

  • AuthScheme: Set this to OAuth.
  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
  • OAuthClientId: Set this to the client_id that is specified in you app settings.
  • OAuthClientSecret: Set this to the client_secret that is specified in you app settings.
  • CallbackURL: Set this to the Redirect URI that is specified in your app settings

Establish a Connection

Open the connection to Todoist by calling the odbc_connect or odbc_pconnect methods. To close connections, use odbc_close or odbc_close_all.

$conn = odbc_connect("CData ODBC API Source","user","password");

Connections opened with odbc_connect are closed when the script ends. Connections opened with the odbc_pconnect method are still open after the script ends. This enables other scripts to share that connection when they connect with the same credentials. By sharing connections among your scripts, you can save system resources, and queries execute faster.

$conn = odbc_pconnect("CData ODBC API Source","user","password"); ... odbc_close($conn); //persistent connection must be closed explicitly

Create Prepared Statements

Create prepared statements and parameterized queries with the odbc_prepare function.

$query = odbc_prepare($conn, "SELECT * FROM Tasks WHERE Completed = ?");

Execute Queries

Execute prepared statements with odbc_execute.

$conn = odbc_connect("CData ODBC API Source","user","password"); $query = odbc_prepare($conn, "SELECT * FROM Tasks WHERE Completed = ?"); $success = odbc_execute($query, array('false'));

Execute nonparameterized queries with odbc_exec.

$conn = odbc_connect("CData ODBC API Source","user","password"); $query = odbc_exec($conn, "SELECT Id, Priority FROM Tasks WHERE Completed = 'false'");

Process Results

Access a row in the result set as an array with the odbc_fetch_array function.

$conn = odbc_connect("CData ODBC Todoist data Source","user","password"); $query = odbc_exec($conn, "SELECT Id, Priority FROM Tasks WHERE Completed = 'false'"); while($row = odbc_fetch_array($query)){ echo $row["Id"] . "\n"; }

Display the result set in an HTML table with the odbc_result_all function.

$conn = odbc_connect("CData ODBC Todoist data Source","user","password"); $query = odbc_prepare($conn, "SELECT * FROM Tasks WHERE Completed = ?"); $success = odbc_execute($query, array('false')); if($success) odbc_result_all($query);

More Example Queries

You will find complete information on the driver's supported SQL in the help documentation. The code examples above are Todoist-specific adaptations of the PHP community documentation for all ODBC functions.