Xero Query Authentication Guide

Xero Query Authentication Guide


Overview

This is a step-by-step guide to creating an OAuth entry, acquiring credentials and authorising the Xero Query connector for use in Matillion ETL.

Important Information

  • The Xero Query connector uses an OAuth for third-party authentication.
  • While connector properties may differ between Cloud Data Warehouses, the authentication process remains the same.

Creating an OAuth Entry in Matillion ETL

  1. In Matillion ETL, on the top left of the screen, click ProjectManage OAuth.

    Please Note

    If a Xero Query connector has already been added to an Orchestration Job, the Manage OAuth window may also be accessed using the following method:

    1. Click the connector icon to open the Properties panel at the bottom of the screen.
    2. Click ... next to the Authentication input, and finally click Manage in the pop-up window.
    Project dropdown menu

    Project dropdown menu

  2. Copy the Callback URL in the field at the top of the window as this will be required in Acquiring Third-Party Credentials.

  3. Click + in the bottom left of the window to open the Create OAuth Entry window.

    New OAuth entry

    New OAuth Entry

  4. Click the Service dropdown menu and select Xero. Then, provide a name for the OAuth in the Name field and click OK.

    Create OAuth Entry window

    Create OAuth Entry window

  5. On returning to the Manage OAuth window, check the list of OAuths to ensure the new entry is listed.

    Please Note

    This entry is Not Configured. Configuration of the OAuth entry will be discussed in Authorising for use in Matillion ETL.

    OAuth Entry list

    New Entry listed on Manage OAuth window


Acquiring Third-Party Credentials

  1. Navigate to the Xero Developer website and click My Apps on menu at the top of the screen. The browser will redirect to a login screen. Enter valid login credentials to continue.

    Xero Developer Homepage

    Xero Developer Homepage

  2. After logging in successfully, the browser will redirect to the My Apps dashboard. In the top right of the page, click New app .

    My apps Dashboard

    My apps Dashboard

  3. The Add a new app window will pop-up. Provide the details for the following fields.

    • App name – provide the name for the new app
    • Company or application URL – provide a company or application URL to be associated with the app
    • OAuth 2.0 redirect URI – paste the Callback URL (copied earlier from the Manage OAuth window in Matillion ETL) into the Redirect URI field

    Please Note

    IP Addresses unfortunately are not be accepted and will need to be mapped to a hostname.

  4. Next, tick the checkbox to confirm agreement with the Xero Developer Platform Terms & Conditions and click Create app.

    Add New App

    Add New App

  5. The App Details page will appear immediately, thereafter. Copy the codes from both the Client id and Client secret fields, as they will be required in Authorising for use in Matillion ETL.

    Please Note

    • Make sure to copy the Client id and Client secret as you might not be able to retrieve them after your perform another operation or leave this page.
    • Additionally, when copying the codes, some browsers may add a space to the end of the string. Watch out for this as it will cause the credentials to fail.
    Copy Client ID and secret

    Copy Client ID and secret


Authorising OAuth for use in Matillion ETL

  1. Return to the Manage OAuth window in Matillion ETL and click next to the previously created OAuth entry. This will open the Configure OAuth window.

    Manage OAuth

    Manage OAuth

  2. Using the codes copied from the Xero Developer website earlier, provide details for the following fields:

    Configure OAuth settings

    Configure OAuth settings