Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/workflows/validate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -74,3 +74,8 @@ jobs:
npm-token: ${{ secrets.NPM_TOKEN }}
node-version: ${{ vars.NODE_VERSION }}
npm-version: ${{ vars.NPM_VERSION }}
- name: Validate OAuth example
run: |
npm ci --prefix example --ignore-scripts
npm run test:example
npm audit --prefix example
23 changes: 23 additions & 0 deletions example/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# QuickBooks OAuth 2.0 example

This local example uses the SDK in the parent checkout, patched EJS, and Node's
built-in `fetch`. It no longer installs the obsolete public SDK or `request`.
Use the Node/npm versions configured for this repository's CI.

From the repository root, run `npm ci` and `npm ci --prefix example`. Register
`http://localhost:3000/callback` as your Intuit development app's redirect URI,
then set `QBO_CLIENT_ID`, `QBO_CLIENT_SECRET`, `SESSION_SECRET` (a randomly
generated secret), and `QBO_REDIRECT_URI` to that same URI in your environment.
Run `npm start --prefix example` and open http://localhost:3000.

The example uses a sandbox company by default. Set `QBO_SANDBOX=false` only
when using your production Intuit app's credentials. Tokens stay on the server
and are never logged or rendered. The callback validates one-time session
state, exchanges the code, and lists account names through the local SDK.

This is a local demonstration: Express's in-memory session store does not
persist connections or refresh tokens. A hosted integration needs a persistent
session/token store and appropriate HTTPS/proxy configuration.

Run `npm run test:example` after installing the example dependencies. CI runs
the example tests and audits its separate lockfile as well as the SDK.
165 changes: 82 additions & 83 deletions example/app.js
Original file line number Diff line number Diff line change
@@ -1,90 +1,89 @@
var http = require('http'),
port = process.env.PORT || 3000,
request = require('request'),
qs = require('querystring'),
util = require('util'),
bodyParser = require('body-parser'),
cookieParser = require('cookie-parser'),
session = require('express-session'),
express = require('express'),
app = express(),
QuickBooks = require('../index')
'use strict';

const { randomBytes } = require('node:crypto');
const path = require('node:path');
const express = require('express');
const session = require('express-session');
const QuickBooks = require('../index');

// Generic Express config
app.set('port', port)
app.set('views', 'views')
app.use(bodyParser.json());
app.use(bodyParser.urlencoded({extended: true}))
app.use(cookieParser('brad'))
app.use(session({resave: false, saveUninitialized: false, secret: 'smith'}));

app.listen(app.get('port'), function() {
console.log('Express server listening on port ' + app.get('port'))
})

// INSERT YOUR CONSUMER_KEY AND CONSUMER_SECRET HERE

var consumerKey = '',
consumerSecret = ''

app.get('/',function(req,res){
res.redirect('/start');
})

app.get('/start', function(req, res) {
res.render('intuit.ejs', {port:port, appCenter: QuickBooks.APP_CENTER_BASE})
})

app.get('/requestToken', function(req, res) {
var postBody = {
url: QuickBooks.REQUEST_TOKEN_URL,
oauth: {
callback: 'http://localhost:' + port + '/callback/',
consumer_key: consumerKey,
consumer_secret: consumerSecret
}
function createExampleApp({ clientId, clientSecret, sessionSecret, redirectUri,
useSandbox = true, fetchToken = fetch, QuickBooksClient = QuickBooks }) {
if (!clientId || !clientSecret || !sessionSecret || !redirectUri) {
throw new Error('Set QBO_CLIENT_ID, QBO_CLIENT_SECRET, SESSION_SECRET and QBO_REDIRECT_URI.');
}
request.post(postBody, function (e, r, data) {
var requestToken = qs.parse(data)
req.session.oauth_token_secret = requestToken.oauth_token_secret
console.log(requestToken)
res.redirect(QuickBooks.APP_CENTER_URL + requestToken.oauth_token)
})
})
const app = express();
app.set('views', path.join(__dirname, 'views'));
app.set('view engine', 'ejs');
app.use(session({
secret: sessionSecret,
resave: false,
saveUninitialized: false,
cookie: { httpOnly: true, sameSite: 'lax', secure: redirectUri.startsWith('https:') },
}));

app.get('/callback', function(req, res) {
var postBody = {
url: QuickBooks.ACCESS_TOKEN_URL,
oauth: {
consumer_key: consumerKey,
consumer_secret: consumerSecret,
token: req.query.oauth_token,
token_secret: req.session.oauth_token_secret,
verifier: req.query.oauth_verifier,
realmId: req.query.realmId
app.get('/', (_req, res) => res.redirect('/start'));
app.get('/start', (_req, res) => res.render('intuit', { accounts: null }));
app.get('/authorize', (req, res, next) => {
req.session.oauthState = randomBytes(32).toString('hex');
const url = new URL('https://appcenter.intuit.com/connect/oauth2');
url.search = new URLSearchParams({
client_id: clientId,
response_type: 'code',
scope: 'com.intuit.quickbooks.accounting',
redirect_uri: redirectUri,
state: req.session.oauthState,
}).toString();
req.session.save((error) => error ? next(error) : res.redirect(url.toString()));
});
app.get('/callback', async (req, res) => {
const { state, code, realmId } = req.query;
if (typeof state !== 'string' || !req.session.oauthState ||
state !== req.session.oauthState || typeof code !== 'string' ||
typeof realmId !== 'string' || !code || !realmId) {
res.status(400).send('Invalid or expired OAuth callback. Start a new connection.');
return;
}
}
request.post(postBody, function (e, r, data) {
var accessToken = qs.parse(data)
console.log(accessToken)
console.log(postBody.oauth.realmId)
delete req.session.oauthState;
try {
await new Promise((resolve, reject) => req.session.save((error) => error ? reject(error) : resolve()));
const response = await fetchToken('https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer', {
method: 'POST',
headers: {
authorization: 'Basic ' + Buffer.from(clientId + ':' + clientSecret).toString('base64'),
'content-type': 'application/x-www-form-urlencoded',
accept: 'application/json',
},
body: new URLSearchParams({ grant_type: 'authorization_code', code, redirect_uri: redirectUri }),
signal: AbortSignal.timeout(15000),
});
if (!response.ok) throw new Error('Token exchange failed');
const token = await response.json();
if (typeof token.access_token !== 'string' || !token.access_token) {
throw new Error('No access token');
}
const qbo = new QuickBooksClient(clientId, clientSecret, token.access_token,
false, realmId, useSandbox, false, null, '2.0', token.refresh_token);
const accounts = await new Promise((resolve, reject) => {
qbo.findAccounts((error, data) => error ? reject(error) : resolve(data.QueryResponse.Account || []));
});
res.render('intuit', { accounts });
} catch (_error) {
res.status(502).send('QuickBooks connection failed. Start a new connection.');
}
});
return app;
}

// save the access token somewhere on behalf of the logged in user
qbo = new QuickBooks(consumerKey,
consumerSecret,
accessToken.oauth_token,
accessToken.oauth_token_secret,
postBody.oauth.realmId,
true, // use the Sandbox
true); // turn debugging on
if (require.main === module) {
const port = process.env.PORT || 3000;
const app = createExampleApp({
clientId: process.env.QBO_CLIENT_ID,
clientSecret: process.env.QBO_CLIENT_SECRET,
sessionSecret: process.env.SESSION_SECRET,
redirectUri: process.env.QBO_REDIRECT_URI,
useSandbox: process.env.QBO_SANDBOX !== 'false',
});
app.listen(port, '127.0.0.1', () => console.log('QuickBooks example listening on http://localhost:' + port));
}

// test out account access
qbo.findAccounts(function(_, accounts) {
accounts.QueryResponse.Account.forEach(function(account) {
console.log(account.Name)
})
})
})
res.send('<!DOCTYPE html><html lang="en"><head></head><body><script>window.opener.location.reload(); window.close();</script></body></html>')
})
module.exports = { createExampleApp };
Loading
Loading