Quick start - using the Google OAuth 2.0 Playground
The Google OAuth 2.0 Playground enables developers to explore OAuth 2.0 compatible APIs without writing code.
To use the FreeAgent API with the Google OAuth 2.0 Playground, you must do the following:
Create a free temporary FreeAgent user account at the FreeAgent Sandbox. We'll link the OAuth Playground to this user account.
Sign into the company and complete the setup stages. If you don't do this, you will receive unexpected error messages when using the API.
Create an App at the FreeAgent Developer Dashboard. Once created, take note of the OAuth identifier and OAuth secret.
Finally, it's time to get an Access Token which can then be used with the
curlor your own apps during development. The following section explains exactly how to generate the Access and Refresh Tokens.
Generate Access & Refresh tokens
This process can be broken into 3 steps.
Configure the OAuth Playground
Go to the Google OAuth 2.0 Playground
The URL above sets up the Playground with FreeAgent's
|OAuth Authorization Endpoint||https://api.sandbox.freeagent.com/v2/approve_app|
|OAuth Token Endpoint||https://api.sandbox.freeagent.com/v2/token_endpoint|
OAuth 2.0 Playground page has loaded, you will notice that the cog button at the top right is clicked and a dialog is already visible, allowing you to enter the OAuth Client ID and OAuth Client Secret from
Step 3 in the previous section.
To use the production API (instead of the sandbox one) change the two endpoints to reference api.freeagent.com instead of api.sandbox.freeagent.com
Hint: With the Link icon you can create a link to save these settings for future use and if you tick Include OAuth credentials and OAuth tokens in the link you won't have to enter the Client ID and Secret each time.
Authorize API usage
On the left hand side now you will see
3 Steps. Expand
Step 1. Our goal is to Authorize API usage. Google OAuth Playground requires you to specify a scope before you can
Authorize APIs. So go ahead and insert a scope name (any string should do) before hitting the now enabled
Authorize APIs button.
The Playground will redirect you to the Sandbox where you will have to log in to the FreeAgent Sandbox account you created (
Step 1 of the previous section). Once logged in you can approve the Playground app.
Approving the app will return you to the Playground.
Generate the API tokens
Click Exchange Authorization Code for Tokens to create access and refresh tokens which can be used to access the API.
You can then access the FreeAgent API for the Sandbox account you authorised. For example try:
which should produce:
Now that you have an Access Token, you can also use it with Curl or use it to test out your own app with the FreeAgent API before you implement OAuth authentication.
Next up, Introducing the FreeAgent API