Debugging can be difficult but it can be especially tedious when dealing with a poorly designed third-party API. Trying to figure out what went wrong based on an ad-hoc debugging strategy of trial-and-error calls to an API, callbacks, and logs is bound to ruin your day.
That’s why we’ve solved this problem for you with our new API Dashboard! The HelloSign API Dashboard is a central resource for you to see your API requests and responses, view the status of your signature requests, and inspect your callbacks for easy troubleshooting and debugging.
We’re the only esign API that provides a tool of this kind for developers and it’s free for all HelloSign accounts.
Getting Started With the HelloSign API Dashboard
Let’s start by making a simple call to our API using curl. We’re going to intentionally create a failing signature request under test mode.
curl https://api.hellosign.com/v3/signature_request/create_embedded / -u '6e65b1699a1b5169296b3bcd77598dw89bcbeffbcbd3430e4797377fd76fc533:' / -F 'client_id=iforgotmyid ' / -F 'signers[email_address]=email@example.com' / -F 'signers[name]=Freddy Rangel' / -F 'file=@public/hellosign_test_template.pdf' / -F 'test_mode=1'
Notice that we’re making this call under test mode and using an incorrect client_id.
Here we can see that our last request resulted in a status 400 which is not what we want. By clicking on that request, we can see more information about what went wrong.
Now we can see a lot more detailed information about the API call. We even have the specific error message which is helpful for debugging.
Now that we know what our error was, let’s go ahead and fix the problem by adding the correct client_id.
curl https://api.hellosign.com/v3/signature_request/create_embedded / -u '6e65b1699a1b5169296b3bcd77598dw48bcbeffbcbd3430e4797377fd76fc533:' / -F 'client_id=4b1a1cc4cc91b41b71597632da28ebb7' / -F 'signers[email_address]=firstname.lastname@example.org' / -F 'signers[name]=Freddy Rangel' / -F 'file=@public/hellosign_test_template.pdf' / -F 'test_mode=1'
It took us less than 2 minutes to debug our failed API request but saved us hours or even days of development work. Think about how much work it would be to find this information if you had to figure it out based on just your logs. The API Dashboard makes it too easy to debug your API requests without going through all that extra work of figuring it out yourself.
Feel free to visit our API Dashboard at hellosign.com/apidashboard. For more information about using the API, connect with an API specialist to see embedded templates and other signature API features in real time.
PS if video is your thing, take a look at this quick walk-through of the API Dashboard: