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 →Access Xero Data from MySQL in PHP
Connect to Xero through the standard MySQL libraries in PHP.
You can use the CData SQL Gateway and ODBC Driver for Xero to access Xero data from MySQL clients, without needing to perform an ETL or cache data. Follow the steps below to connect to Xero data in real time through PHP's standard MySQL interfaces, mysqli and PDO_MySQL.
About Xero Data Integration
Accessing and integrating live data from Xero has never been easier with CData. Customers rely on CData connectivity to:
- Connect to Xero Accounts and both US and Australian Payroll APIs.
- Read, write, update, and delete Xero objects like Customers, Transactions, Invoices, Sales Receipts and more.
- Use SQL stored procedures for actions like adding items to a cart, submitting orders, and downloading attachments.
- Work with accounting, payroll, file, fixed asset, and project data.
Customers regularly integrate their Xero data with preferred tools, like Tableau, Qlik Sense, or Excel, and integrate Xero data into their database or data warehouse.
Getting Started
Connect to Xero Data
If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.
To connect, set the Schema connection property in addition to any authentication values. Xero offers authentication for private applications, public applications, and partner applications. You will need to set the XeroAppAuthentication property to PUBLIC, PRIVATE, or PARTNER, depending on the type of application configured. To connect from a private application, you will additionally need to set the OAuthAccessToken, OAuthClientId, OAuthClientSecret, CertificateStoreType, CertificateStore, and CertificateStorePassword.
To connect from a public or partner application, you can use the embedded OAuthClientId, OAuthClientSecret, and CallbackURL, or you can register an app to obtain your own OAuth values.
See the "Getting Started" chapter of the help documentation for a guide to authenticating to Xero.
Configure the SQL Gateway
See the SQL Gateway Overview to set up connectivity to Xero data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.
Connect in PHP
The following examples show how to use object-oriented interfaces to connect and execute queries. Initialize the connection object with the following parameters to connect to the virtual MySQL database:
- Host: Specify the remote host location where the service is running. In this case "localhost" is used for the remote host setting since the service is running on the local machine.
- Username: Specify the username for a user you authorized on the SQL Gateway's Users tab.
- Password: Specify the password for the authorized user account.
- Database Name: Specify the system DSN as the database name.
- Port: Specify the port the service is running on; port 3306 in this example.
mysqli
<?php $mysqli = new mysqli("localhost", "user", "password", "CData Xero Sys","3306"); ?>
PDO
<?php $pdo = new PDO('mysql:host=localhost;dbname=CData Xero Sys;port=3306', 'user', 'password'); ?>
Query in PHP
With the connection established, you can then access tables. The following steps walk through the example:
- Query the table; for example, Items. The results will be stored as an associative array in the $result object.
- Iterate over each row and column, printing the values to display in the PHP page.
- Close the connection.
mysqli
$result = $mysqli->query("SELECT Name, SUM(QuantityOnHand) FROM Items GROUP BY Name"); while($row = $result->fetch_assoc()) { foreach ($row as $k=>$v) { echo "$k : $v"; echo "<br>"; } } $mysqli->close();
PDO
$result = $pdo->query("SELECT Name, SUM(QuantityOnHand) FROM Items GROUP BY Name"); while($row = $result->fetch(PDO::FETCH_ASSOC)) { foreach ($row as $k=>$v) { echo "$k : $v"; echo "<br>"; } } $result = null; $pdo = null;