The Intuit Developer team has written this OAuth 2.0 Sample App in Java to provide working examples of OAuth 2.0 concepts, and how to integrate with Intuit endpoints.
- Requirements
- First Use Instructions
- Running the code
- Configuring the callback endpoint
- Getting the OAuth Tokens
- Scope
- Storing the Tokens
- Discovery document
In order to successfully run this sample app you need a few things:
- Java 1.8
- A developer.intuit.com account
- An app on developer.intuit.com and the associated client id and client secret.
- Clone the GitHub repo to your computer
- Fill in the
application.propertiesfile values (OAuth2AppClientId, OAuth2AppClientSecret) by copying over from the keys section for your app.
Once the sample app code is on your computer, you can do the following steps to run the app:
- cd to the project directory
- Run the command:
./gradlew bootRun(Mac OS) orgradlew.bat bootRun(Windows) - Wait until the terminal output displays the "Started Application in xxx seconds" message.
- Your app should be up now in http://localhost:8080/
- The oauth2 callback endpoint in the sample app is http://localhost:8080/oauth2redirect
- To run the code on a different port, uncomment and update server.port property in application.properties
You'll have to set a Redirect URI in the Developer Portal ("Keys" section). With this app, the typical value would be http://localhost:8080/oauth2redirect, unless you host this sample app in a different way (if you were testing HTTPS, for example).
Note: Using localhost and http will only work when developing, using the sandbox credentials. Once you use production credentials, you'll need to host your app over https.
The sample app supports the following flows:
Sign In With Intuit - this flow requests OpenID only scopes. Feel free to change the scopes being requested in application.properties. After authorizing (or if the account you are using has already been authorized for this app), the redirect URL (/oauth2redirect) will parse the JWT ID token, and make an API call to the user information endpoint.
Connect To QuickBooks - this flow requests non-OpenID scopes. You will be able to make a QuickBooks API sample call (using the OAuth2 token) on the /connected landing page. Sample implementation for RefreshToken and RevokeToken is also available in that page.
Get App Now (Connect Handler) - this flow requests both OpenID and non-OpenID scopes. It simulates the request that would come once a user clicks "Get App Now" on the apps.com website, after you publish your app.
It is important to ensure that the scopes your are requesting match the scopes allowed on the Developer Portal. For this sample app to work by default, your app on Developer Portal must support Accounting scopes. If you'd like to support both Accounting and Payment, simply add thecom.intuit.quickbooks.payment scope in the application.properties file.
This app stores all the tokens and user information in the session. For production ready app, tokens should be encrypted and stored in a database.
The app calls the discovery API during starup and loads all the endpoint urls. For production ready app, make sure to run this API once a day to get the latest urls.