icoretchi / qbd-api

An API web service for QuickBooks Desktop

QBD API

An API for QuickBooks Desktop (QBD). This uses the MySQL database created by Synergration's OpenSync as its backing datastore. You simply issue REST-ful HTTP calls against QBD API and it will fetch and persist the data.

Of course, you will need OpenSync running and a licensed copy of QuickBooks Desktop to synchronize the MySQL database with QuickBooks.

Design

This is an example of a Hexagonal Architecture (also known as Ports and Adapters Architecture). In contrast to a layered architecture (such as Model-View-Controller), this further enforces a separation of concerns by making it more difficult for logic to bleed across concerns.

Having a great deal of experience with layered MVC web applications, I found it rather difficult to wrap my head around the implementation of a Hexagonal Architecture. But after plowing through I actually find it quite liberating. When you need focus on the application core (the business logic), you are freed from the details of incoming connections and outgoing database persistence.

To build QBD API

./gradlew build

To run QBD API

Use Docker:

1. Copy the file dev-env-sample to dev-env. Edit dev-env and replace the values of those environment variables with your own AWS Region and Cognito User Pool ID
2. ./gradlew docker
3. docker-compose up

To Check the Health of QBD API

curl --include -X GET http://localhost:8080/qbd-api/manage/health

You should get an HTTP Status code 200 OK, along with a little JSON that says "status" is "UP".