This guide will walk you through the process of connecting Graphweaver to the Xero API. An example of a Xero integration can be found on the Graphweaver Github.

Prerequisites

Before you begin, ensure that you have the following prerequisites:

• Node.js 18 or greater installed
• pnpm version 8 or greater installed

Step 1: Obtain Xero API Credentials

Before you start, you'll need to obtain API credentials from Xero. These include a client_id, client_secret, redirect_uri. Refer to the Xero developer documentation for details on obtaining these credentials.

Step 2: Project Initialisation

Create a new Graphweaver project by running the following command:

npx graphweaver@latest init

Follow the prompts to set up your project. Provide a name when prompted, and select the REST backend for connecting to Xero.

Install the dependencies in your project and install xero-node:

cd your-project-name
pnpm i
pnpm i xero-node

Ensure your Graphweaver instance starts with:

pnpm start

Step 3: Configure Xero API Connection

Create a file named .env in your project directory and configure the connection details for the Xero API:

XERO_CLIENT_ID="[value from Xero]"
XERO_CLIENT_SECRET="[value from Xero]"
XERO_CLIENT_REDIRECT_URIS="<http://localhost:9000/xero-auth-code>"