Skip to content

Commit 32253c1

Browse files
committed
updated table contents
1 parent 0b492ad commit 32253c1

File tree

1 file changed

+19
-34
lines changed

1 file changed

+19
-34
lines changed

smallbizhack-sydney/README.md

Lines changed: 19 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,15 @@
44
* [The challenge](#the-challenge)
55
* [APIs at your disposal](#apis-at-your-disposal)
66
* [Intro to the QuickBooks APIs](#intro-to-the-quickbooks-apis)
7-
* [Creating your QuickBooks app](#creating-your-quickbooks-app)
8-
* [Setting up OAuth 2.0 access](#setting-up-oauth-20-access)
9-
* Hello QuickBooks!
7+
* [Useful developer tools](#useful-developer-tools)
8+
* [Hello QuickBooks - 5 minutes tutorial](#helloquickbooks-5minutestutorial)
9+
* [Creating your QuickBooks app](#creating-your-quickbooks-app)
10+
* [Setting up OAuth 2.0 access](#setting-up-oauth-20-access)
1011
* [Testing the API with Postman](#testing-the-api-with-postman)
11-
* [Implementing the API with our sample code](#implementing-the-api-with-our-sample-code)
12-
* Get notified when data changes
12+
* [Going deeper with the QuickBooks API](#going-deeper-with-the-quickbooks-api)
1313
* [Webhooks](#webhooks)
1414
* [Change data capture (CDC)](#change-data-capture-cdc)
1515

16-
17-
1816
# The challenge
1917
**Create a solution that saves a small business time or money**
2018

@@ -39,18 +37,26 @@ Common tasks performed by the QuickBooks API include:
3937

4038
Check the [API reference](https://developer.intuit.com/docs/api/accounting) for the complete list of APIs. Do also check our app marketplace [apps.com](https://www.apps.com) for example of use cases and apps which use the QuickBooks APIs.
4139

40+
# Useful developer tools
41+
42+
* Download [samples and SDKs](https://intuitdeveloper.github.io/)
43+
* Explore the API using the [API explorer](https://developer.intuit.com/v2/apiexplorer?apiname=V3QBO#?id=Account)
44+
* Explore the API using [Postman](https://developer.intuit.com/docs/00_quickbooks_online/2_build/20_explore_the_quickbooks_online_api/20_postman)
45+
* Use [Sandbox](https://developer.intuit.com/v2/ui#/sandbox) for testing
46+
47+
# Hello QuickBooks - 5 minutes tutorial
4248

43-
# Creating your QuickBooks app
49+
## Creating your QuickBooks app
4450

4551
1. Sign up for an account at [https://developer.intuit.com](https://developer.intuit.com)
4652

4753
2. Click on **my apps** and choose the **Just start coding** option. Select access to the **accounting** API and click **create app** ![alt-text](https://intuitdeveloper.github.io/assets/img/create-app.png "create your QuickBooks app")
4854

49-
3. You should now be greeted by your QuickBooks app dashboard. Head over the **Keys** section and note down your `client Id` and `client secret` ![alt-text](https://intuitdeveloper.github.io/assets/img/get-your-keys.jpg "Get your app keys")
55+
3. You should now be greeted by your QuickBooks app dashboard. Head over the **Keys** section and note down your `client Id` and `client secret` ![alt-text](https://intuitdeveloper.github.io/assets/img/get-your-keys.jpg "Get your app keys")
5056

5157
4. Create a [Sandbox company](https://developer.intuit.com/v2/ui#/sandbox). Select `Australia` in the drop down country list and click **add** to create a AU small business account with dummy data. Take a moment to login your sandbox account and play around the QuickBooks application to understand how it works. ![alt-text](https://intuitdeveloper.github.io/assets/img/create-sandbox.jpg "Create sandbox account")
5258

53-
# Setting up OAuth 2.0 access
59+
## Setting up OAuth 2.0 access
5460

5561
If you are not familiar with OAuth 2.0, check [understand OAuth in 5 mins](https://aaronparecki.com/oauth-2-simplified/#roles)
5662

@@ -81,8 +87,6 @@ Here's a run down of the OAuth response from QuickBooks:
8187
* `refresh_token`: *Required to acquire a short lived `access token`. These last 100 days, but whenever our token endpoint returns a new one for the same company, start using it instead for subsequent calls. If the token is lost, generate a new refresh token by re-authorising your app.*
8288
* `id_token`: *JSON web token containing information about the user and company which authorised your app. The token is base 64 encoded. You can head to https://jwt.io/ to decode it and check what is in there.*
8389

84-
# Hello QuickBooks!
85-
8690
## Testing the API with Postman
8791

8892
The Postman client is a great way to navigate the QuickBooks API before you get your hands deep into into your code. You can skip and directly implement the QuickBook API using the sample code provided for this Hackathon - see section [Implementing the API with our sample code](#implementing-the-api-with-our-sample-code)
@@ -111,25 +115,14 @@ The Postman client is a great way to navigate the QuickBooks API before you get
111115

112116
6. Click **Send**. You should get back a list of customers who have unpaid balance. ![alt-text](https://intuitdeveloper.github.io/assets/img/postman-sample-response.jpg "Postman access token")
113117

118+
# Going deeper with the QuickBooks API
114119

115-
## Implementing the API with our sample code
116-
117-
Samples are available in the following languages, use the readme within the individual language folder for additional instructions on how to run the sample and plugin the OAUth 2.0 token.
118-
119-
* [DotNet](https://github.com/IntuitDeveloper/HackathonSamples/tree/master/dotnet/SampleApp_hackathon)
120-
* [Java](https://github.com/IntuitDeveloper/HackathonSamples/tree/master/java)
121-
* [Nodejs](https://github.com/IntuitDeveloper/HackathonSamples/tree/master/nodejs)
122-
* [PHP](https://github.com/IntuitDeveloper/HackathonSamples/blob/master/php)
123-
* [Python](https://github.com/IntuitDeveloper/HackathonSamples/blob/master/python)
124-
125-
126-
# Get notified when data changes
120+
## Get notified when data changes
127121

128122
To track data changes there are different mechanisms:
129123
* Change data capture (CDC): run a periodic query with date filter to download what changed since your last run.
130124
* Webhooks: register a listener for change events
131125

132-
133126
## Webhooks
134127

135128
With webhooks enabled for your application, Intuit will notify your endpoint within 5 mins of a
@@ -149,12 +142,4 @@ subscribe to changes to all entities
149142

150143
Change data capture is the second mechanism for downloading changes to data in QuickBooks
151144
since you last checked. You will need to track the last date you called this API. In request
152-
params you can provide both a list of entities & last check date.
153-
154-
155-
156-
157-
158-
159-
160-
145+
params you can provide both a list of entities & last check date.

0 commit comments

Comments
 (0)