Learn more
 

Ready to get started?

Download a free trial of the Xero Driver to get started:

 Download Now

Learn more:

Xero Icon Xero JDBC Driver

Complete read-write access to Xero accounting enables developers to search (Customers, Transactions, Invoices, Sales Receipts, etc.), update items, edit customers, and more, from any Java/J2EE application.

In this article

Related articles

Access Xero Data in Mule Applications Using the CData JDBC Driver


Create a simple Mule Application that uses HTTP and SQL with CData JDBC drivers to create a JSON endpoint for Xero data.

The CData JDBC Driver for Xero connects Xero data to Mule applications enabling read , write, update, and delete functionality with familiar SQL queries. The JDBC Driver allows users to easily create Mule applications to backup, transform, report, and analyze Xero data.

This article demonstrates how to use the CData JDBC Driver for Xero inside of a Mule project to create a Web interface for Xero data. The application created allows you to request Xero data using an HTTP request and have the results returned as JSON. The exact same procedure outlined below can be used with any CData JDBC Driver to create a Web interface for the 200+ available data sources.

  1. Create a new Mule Project in Anypoint Studio.
  2. Add an HTTP Connector to the Message Flow.
  3. Configure the address for the HTTP Connector.
  4. Add a Database Select Connector to the same flow, after the HTTP Connector.
  5. Create a new Connection (or edit an existing one) and configure the properties.
    • Set Connection to "Generic Connection"
    • Select the CData JDBC Driver JAR file in the Required Libraries section (e.g. cdata.jdbc.xero.jar).
    • Set the URL to the connection string for Xero

      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.

      Built-in Connection String Designer

      For assistance in constructing the JDBC URL, use the connection string designer built into the Xero JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

      java -jar cdata.jdbc.xero.jar

      Fill in the connection properties and copy the connection string to the clipboard.

    • Set the Driver class name to cdata.jdbc.xero.XeroDriver.
    • Click Test Connection.
  6. Set the SQL Query Text to a SQL query to request Xero data. For example: SELECT Name, SUM(QuantityOnHand) FROM Items GROUP BY Name
  7. Add a Transform Message Component to the flow.
  8. Set the Output script to the following to convert the payload to JSON: 
    %dw 2.0
output application/json
---
payload
  9. To view your Xero data, navigate to the address you configured for the HTTP Connector (localhost:8081 by default): http://localhost:8081. The Xero data is available as JSON in your Web browser and any other tools capable of consuming JSON endpoints.

At this point, you have a simple Web interface for working with Xero data (as JSON data) in custom apps and a wide variety of BI, reporting, and ETL tools. Download a free, 30 day trial of the JDBC Driver for Xero and see the CData difference in your Mule Applications today.