You've reached this page because you've heard rumors about the Usabilla Public API and its possibilities. I'm proud to be able to say, you came to the right place. Whether it's to retrieve Feedback from Usabilla to populate your own Dashboards or retrieve Feedback to import it in a Solutions of your own choice. To get you started on your journey, I'm going to help you with your papers, well... Credentials.😄
In this article, I'll help you to get started with our Public API. After reading this article you'll have the answers to:
- Where to find Public API credentials
- What to do when the credentials aren't visible
- What to do when the Secret Key is lost
What do you need:
- A Usabilla account with an Administrator role
Where can I find the Public API credentials?
- Navigate to the 'Account Settings':
- Open the 'Public API' tab:
- The Access Key and the moment when the Secret Key of your account was generated will be listed here:
You're not seeing the same situation in the screenshot above? Not to worry, I came prepared! If you're seeing a red button with the text 'Request Public API access' instead, click here. If you are seeing the same as the screenshot above but you don't know what your Secret Key is, click here.
What do I do when the credentials aren't visible?
If there are no credentials to be found in the 'Public API' tab, chances are you're seeing a red button with the text 'Request API access' instead:
No worries, this simply means that there were no credentials generated for your account yet and our Public API wasn't used before. To generate credentials, hit the 'Request API access' button and you'll end up with a brand new and fresh set of credentials:
Note: After the credentials are generated, the Secret Key will be only visible while you're viewing the 'Public API' tab or are when you're browsing through the 'Account Settings'. Once you leave the 'Account Settings' the Secret Key will be hidden to secure the data in your account. Unfortunately, we are not able to retrieve the Secret Key for you. Please make sure to store it safely.
What to do when the Secret Key is lost?
If the 'Public API' tab shows you the Access Key, but you have forgotten the Secret Key, we've also got your back. Hold on, "Why is it hidden?" I hear you ask. Well, to secure the data in your Usabilla account, the Secret Key is hidden after it's generated or regenerated and you exit the 'Account Settings' section.
Note: It's not possible for us to retrieve the once generated Secret Key. Please make sure to store it safely after it's generated or regenerated.
Once you've found yourself in this situation and you can't retrieve the Secret key from your colleagues or other Usabilla users, you can regenerate a new Secret Key. This can be done by selecting the 'Regenerate Secret Key' button:
Note: Consult your colleagues and other users of Usabilla before clicking this button, please. Once this button is clicked, the old Secret Key will become invalid. If you have calls set up with the previous Secret Key, those calls will fail and instead of Feedback, an error message will be returned.
When the "regeneration process" has been completed, you'll be presented with a screen looking very much like this:
Like a famous person once said: "And that's it." Now that you have the credentials to use our Public API, I would recommend having a look at our Public API Documentation. In the documentation, we'll be covering the specifics of setting up your call and what your calls should look like when retrieving Feedback across our product. Have fun!