5 Things to Consider before making API Enhancements
We recently implemented a very important enhancement to our external API. This enhancement was to enable external booking via API. In this article, we’ll cover key learnings and outline the most important points to consider when planning an API enhancement.
The scope of the enhancement included not only client creation and booking of our base package, but also booking of additional add ons such as Datev, OSS/IOSS, Proforma and Intrastat. This API enhancement means that we can now easily cooperate with external partners and offer booking of our services via their platforms. And this enhancement was a great success; in June alone, there was a 20 percent surge of new Taxdoo customers signing up via the API.
Are you a developer or product owner considering how to optimise your product’s API?
We reflected on the key learnings of this project and summarised the top five points to consider for you embarking on similar projects.
1. Scope out the Current and Potential Future Impacts of these Enhancements
When enhancing your API, it can be easy to look solely at the ‘now’ and what you’re trying to achieve in this particular instance.
However, the API is a living thing which will continue to grow and evolve along with your organisation.
When making changes it is important to try to scope out a scalable solution which could encompass possible future enhancements or, at the very least, try not to limit this possibility. Additionally, each time changes are being made, you should also make sure to re-evaluate any existing limitations in the context of the new and improved version of the API so that it meets the latest standards available.
2. Get Development Insight as Early on as Possible
It goes without saying that API enhancements are a very tech heavy task which developers will be carrying out, however, it can be easy to overlook how early on in the process of scoping out they should be involved.
In order to fully understand the complexity of the changes, or related changes (see below), it is crucial to have insights from developers as early on as possible. Involving the developers enables you to better identify certain blind spots that you as a Product or Project Manager might have in relation to what is technically possible. For example, triggering a certain process in a different API might not yet be possible, or might only be possible in a certain way or format that might be outside of the initial scope or timeline of the current project.
This early involvement is crucial in order to be able to agree on more realistic and accurate deadlines for delivering the desired enhancements and can better coordinate the go-to-market strategy.
3. Document Internal Processes that need to be Considered
When enhancing the external API to allow for key functions such as client creation and booking of add-ons, it is crucial to make sure you have either documented or walked through the entire workflow to make sure that all subsequent processes will be correctly triggered in order to create a seamless interaction.
Your aim is to ensure the nature of the feature or function remains in tact. For example, when creating clients through the API you need to not only ensure the clients are created but that all welcome mails are triggered and clients know what to do next and where. Often the act of simply carrying out the basic function isn’t enough to trigger the subsequent processes so going through and documenting the entire workflow enables you to pinpoint this early on and ensure it is also considered as part of the development work required.
4. Align Internal and External Workflows
When carrying out enhancements to the API to enable specific functions in cooperation with partners, or even in consideration of relevant external processes, it is very important to align the internal and external workflows which are to be expected. This will be particularly important when it comes to smoothing out the launch.
Like the point above, the internal processes and considerations to be taken into account are numerous but ensuring those are aligned before the go-live will make everyone’s lives a little bit easier. For example, how do clients created through the API book additional add ons? What additional concerns or support processes might vary for clients created via API vs. those booked directly? When carrying out these changes in co-operation with a partner, or due to external changes in the industry, it is also important to make sure the expectations there are aligned.
5. Be Loud!
The point of having a public, external-facing API is that it allows third parties to develop apps that interact with your API and can be a source for innovation. Therefore, when you’ve made changes to your API that could provide new sources of innovation, it’s a great idea to be loud!
Write blogs, such as this one, post to Twitter and development related to forums to get the word out there. By being loud, you can gather some interest in your newly enhanced API and create momentum for further enhancements.
Have you been involved with a similar project? What did you learn or would like to do again differently when implementing API enhancements?
Our Taxdoo API Support Community, including documentation, helpful hints and monitored forum discussions can be found here.
At Taxdoo, we believe that different opinions, skill sets and open communication create the best products. Did you find this article insightful? We would love to hear your feedback. Generally interested in staying in touch? Follow us on Twitter or Dev.to for the latest updates and new vacancies from the team at Taxdoo.
