Interactive code snippets and more, in the latest API doc refresh
Our API docs have had a refresh and are looking sleeker than ever! Generate code snippets across 19 languages, have a more detailed view of error responses at an end point level and call the Basiq API directly from the docs is coming soon!
Why the update?
We heard our partners loud and clear that the docs could use an uplift, were hard to navigate and a little tough to use.
The new API docs deliver so much more value to our partners including:
- An uplifted UI that is easier to navigate
- A more streamlined API document experience, speeding up your developer time
- A reduced learning curve, as the docs cater to a wider variety of different developers
All of these great new features are available in version 3 of the Basiq API. If you are not currently using version 3 and would like to upgrade, check out our support guide here.
So *drum-roll* What’s new?
Interactive code snippets
Our API Docs are now available to be generated in 19 different developer languages and are completely interactive. Spin up your API requests directly from the API docs and copy the code in the language of your choice!
Detailed error responses per endpoint
Previously error responses for all endpoint’s were displayed on a single page.
Now you can dive into error responses attached solely to each end point – no more scrolling through an endless list! We’ll only surface what’s relevant to what you’re looking for.
Populate an API request directly from the API docs
Coming soon.. While it’s still in the works, you’ll soon be able to make requests directly and call the Basiq API, in browser, from our documentation!
In the meantime we’re excited for you to play around with our interactive docs, allowing you to populate your requests directly using the input fields provided, and then generate your code snippets into 19 languages ready to paste right into your codebase.
As mentioned, all of these great new features are available in version 3 of the Basiq API. If you are not currently using version 3 and would like to upgrade, check out our support guide here.
Stay tuned for more updates!