api-python-flask-sampleapp

This Flask application demonstrates how developers can use the FreshBooks API to let users login to their application through OAuth2 then access and modify the users' information using the endpoints provided to them.

If you would like to use PostMan to get familiar with using FreshBooks API, please watch this tutorial.

Setting up you developer account

• Create a new FreshBooks account by signing up on the signup page.
• Visit the developer page and create a new app.

Make sure that your redirect uri ends with /TestAuthentication, since this will be the endpoint used to verify that you have successfully set up your application on FreshBooks developer page. For example,

https://localhost:5000/TestAuthentication

• Once you have created the application, keep the developer page open as you will need it for the next step.

Running the Flask app

• Make sure you have Python3 installed on your computer.
• Clone this repo into your computer.
• Create a new .env file in the root folder of the project. The .env file should at least contain the following variables

CLIENT_ID='<YOUR-CLIENT-ID>'
CLIENT_SECRET='<YOUR-CLIENT-SECRET>'
REDIRECT_URL='<YOUR-REDIRECT-URI>'

The values for these variables are available on the developer page

• Install all the dependencies for this project as mentioned on the requirements.txt by running the following commands

$ pipenv install
$ pipenv shell

If you do not have pipenv installed visit their GitHub for instructions on how to do so.

• Run the app using the Flask command.

$ flask run --cert=adhoc

• Click on the Authorizaton URL for you application available on the developer page
• Login to the FreshBooks application using the credentials for the test account given to you during the hackathon. If you have correctly set up you application on FreshBooks and entered your credentials on the .env file you should get the following output.

You have successfully logged in for First Last

If you can see the above output, congrats you can now start building your application using the Freshbooks API. If you do not see the message, you will have to go over the instructions again.

Hope you have a fun hackathon experience.

Cheers!