We are proud to share our inclusion in the 2024 Gartner Magic Quadrant for Data Integration Tools. We believe this recognition reflects the differentiated business outcomes CData delivers to our customers.
Get the Report →Natively Connect to TaxJar Data in PHP
The CData ODBC driver for TaxJar enables you to create PHP applications with connectivity to TaxJar data. Leverage the native support for ODBC in PHP.
Drop the CData ODBC Driver for TaxJar into your LAMP or WAMP stack to build TaxJar-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to TaxJar 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.
To authenticate to the TaxJar API, you will need to first obtain the API Key from the TaxJar UI.
NOTE: the API is available only for Professional and Premium TaxJar plans.
If you already have a Professional or Premium plan you can find the API Key by logging in the TaxJar UI and navigating to Account -> TaxJar API. After obtaining the API Key, you can set it in the APIKey connection property.
Additional Notes
- By default, the CData connector will retrieve data of the last 3 months in cases where the entity support date range filtering. You can set StartDate to specify the minimum creation date of the data retrieved.
- If the API Key has been created for a sandbox API account please set UseSandbox to true, but not all endpoints will work as expected. For more information, refer to the TaxJar developer documentation.
Establish a Connection
Open the connection to TaxJar by calling the odbc_connect or odbc_pconnect methods. To close connections, use odbc_close or odbc_close_all.
$conn = odbc_connect("CData ODBC TaxJar 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 TaxJar 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 Orders WHERE TransactionID = ?");
Execute Queries
Execute prepared statements with odbc_execute.
$conn = odbc_connect("CData ODBC TaxJar Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Orders WHERE TransactionID = ?");
$success = odbc_execute($query, array('123'));
Execute nonparameterized queries with odbc_exec.
$conn = odbc_connect("CData ODBC TaxJar Source","user","password");
$query = odbc_exec($conn, "SELECT TransactionID, UserID FROM Orders WHERE TransactionID = '123'");
Process Results
Access a row in the result set as an array with the odbc_fetch_array function.
$conn = odbc_connect("CData ODBC TaxJar data Source","user","password");
$query = odbc_exec($conn, "SELECT TransactionID, UserID FROM Orders WHERE TransactionID = '123'");
while($row = odbc_fetch_array($query)){
echo $row["TransactionID"] . "\n";
}
Display the result set in an HTML table with the odbc_result_all function.
$conn = odbc_connect("CData ODBC TaxJar data Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Orders WHERE TransactionID = ?");
$success = odbc_execute($query, array('123'));
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 TaxJar-specific adaptations of the PHP community documentation for all ODBC functions.