Natively Connect to Gumroad Data in PHP

Drop the CData ODBC Driver for Gumroad into your LAMP or WAMP stack to build Gumroad-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to Gumroad 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.

Using OAuth Authentication

To authenticate to Gumroad and connect to your own data or to allow other users to connect to their data, you can use the OAuth 2.0 standard. This is the recommended authentication method.

First you need to register an OAuth application with Gumroad. You can create an OAuth application by visiting your Gumroad account settings at https://app.gumroad.com/settings/advanced and navigating to the Applications section.

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

• AuthScheme: Set this to OAuth.
• InitiateOAuth: Set this to GETANDREFRESH. The CData API Profile for Gumroad will automatically walk through the OAuth process in order to obtain the access token.
• OAuthClientID: Set this to the client_id that is specified in your app settings.
• OAuthClientSecret: Set this to the client_secret that is specified in your app settings.
• CallbackURL: Set this to the Redirect URI you specified in your app settings.

Example connection string

Profile=C:\profiles\Gumroad.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

Establish a Connection

Open the connection to Gumroad 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 CustomFields WHERE ProductId = ?");

Execute Queries

Execute prepared statements with odbc_execute.

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

Execute nonparameterized queries with odbc_exec.

$conn = odbc_connect("CData ODBC API Source","user","password");
$query = odbc_exec($conn, "SELECT ,  FROM CustomFields WHERE ProductId = 'prod_abc123xyz'");
  

Process Results

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

$conn = odbc_connect("CData ODBC Gumroad data Source","user","password");
$query = odbc_exec($conn, "SELECT ,  FROM CustomFields WHERE ProductId = 'prod_abc123xyz'");
while($row = odbc_fetch_array($query)){
 echo $row[""] . "\n";
}

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

$conn = odbc_connect("CData ODBC Gumroad data Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM CustomFields WHERE ProductId = ?");
$success = odbc_execute($query, array('prod_abc123xyz'));
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 Gumroad-specific adaptations of the PHP community documentation for all ODBC functions.