You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
*[Creating your QuickBooks app](#creating-your-quickbooks-app)
10
+
*[Setting up OAuth 2.0 access](#setting-up-oauth-20-access)
10
11
*[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)
13
13
*[Webhooks](#webhooks)
14
14
*[Change data capture (CDC)](#change-data-capture-cdc)
15
15
16
-
17
-
18
16
# The challenge
19
17
**Create a solution that saves a small business time or money**
20
18
@@ -39,18 +37,26 @@ Common tasks performed by the QuickBooks API include:
39
37
40
38
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.
41
39
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
42
48
43
-
# Creating your QuickBooks app
49
+
##Creating your QuickBooks app
44
50
45
51
1. Sign up for an account at [https://developer.intuit.com](https://developer.intuit.com)
46
52
47
53
2. Click on **my apps** and choose the **Just start coding** option. Select access to the **accounting** API and click **create app**
48
54
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`
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`
50
56
51
57
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. 
52
58
53
-
# Setting up OAuth 2.0 access
59
+
##Setting up OAuth 2.0 access
54
60
55
61
If you are not familiar with OAuth 2.0, check [understand OAuth in 5 mins](https://aaronparecki.com/oauth-2-simplified/#roles)
56
62
@@ -81,8 +87,6 @@ Here's a run down of the OAuth response from QuickBooks:
81
87
*`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.*
82
88
*`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.*
83
89
84
-
# Hello QuickBooks!
85
-
86
90
## Testing the API with Postman
87
91
88
92
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
111
115
112
116
6. Click **Send**. You should get back a list of customers who have unpaid balance. 
113
117
118
+
# Going deeper with the QuickBooks API
114
119
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.
0 commit comments