Make a Test Call
Running into trouble at the very start of building an integration? Let’s break the problem down.
Copy, paste, and run the command from the code pane on any Mac or Linux computer, or a Windows computer with Curl installed. The response will help us figure things out.
It worked!
If you see something like the response shown, wahoo! We’re communicating fine. Look closely at our example and your code to find the differences and zoom in on a fix.
I don’t see the user info…
If you get an authentication problem or only see the version, you don’t seem to be authenticated as a user. Give our Authentication documentation a try.
I don’t see anything like that!
If you don’t receive either of those, you could be missing a key ingredient — if you aren’t a developer, this might be the time to find one near you and get them involved!
Last resort: Just ask us!
If there’s no one around to help, we’ve got your back. Shoot us an email and tell us what you’re aiming to accomplish, what you’ve done so far, and what went wrong. Maybe we can find the missing piece of the puzzle together.
Authorized Response
Copy from the line below:
curl -X GET
-H "Api-Version: alpha"
-H "Authorization: Bearer <insert your bearer token here>"
"https://api.freshbooks.com/test"to the line above this. You should get a response like below:
{
"version": "alpha",
"user": {
"first_name": "Bruce",
"last_name": "Wayne",
"email": "[email protected]"
}
}Example Auth Error
{
"message": "There was an issue with your provided authorization token.",
"error_type": "unauthorized"
}With no Authorization
Try without the Authorization header like so:
curl -X GET
-H "Api-Version: alpha"
"https://api.freshbooks.com/test"You should get a response like below:
{
"version": "alpha"
}Still doesn’t work? Find a friend or email us at the link back in the content pane.
If that did work: read our Authentication docs and roll on ahead!
Authorized Response
Copy from the line below:
url = "https://api.freshbooks.com/test"
headers = {'Authorization': 'Bearer ', 'Api-Version': 'alpha'}
res = requests.get(url, data=None, headers=headers)
to the line above this, you should get a response like below:
{
"version": "alpha",
"user": {
"first_name": "Bruce",
"last_name": "Wayne",
"email": "[email protected]"
}
}
Example Auth Error
{
"message": "There was an issue with your provided authorization token.",
"error_type": "unauthorized"
}
With no Authorization
Try without the Authorization header like so:
url = "https://api.freshbooks.com/test"
headers = {'Api-Version': 'alpha'}
res = requests.get(url, data=None, headers=headers)
Still doesn’t work? Find a friend or email us at the link back in the content pane.
if that did work: read our Authentication docs and roll on ahead!
sds