What is it?
Nova Poshta Developers Portal is a website with interactive API documentation of the company. It was created using Azure API Management product. Developers Portal has all the tools to make it easy for developers to start using API of the company. In addition to API documentation, the portal allows to get technical support and consulting from API developers of Nova Poshta. There are also news and announcements about API. It has been online more than a year and collected positive feedback from developers community.
We had a target to change the way Nova Poshta handles the documentation and communication to the community of its developers as soon as possible. At first stage, we evaluated solutions on the market for API management. Among the number of possible solutions including custom development, we gravitated the solutions from Microsoft for the following reasons:
– Nova Poshta has had Enterprise Agreement with Microsoft.
– Microsoft offers API management portal from their cloud Azure on a subscription basis.
– The product covered all needed features.
– We expected the best time to market with this product.
After the product was selected, we agreed on the plan to have a pilot, evaluation and then the final release. We created pilot install of the portal with a subset of APIs. After the successful evaluation, we accompanied Nova Poshta developers to create documentation for another part of API documentation. This was kind of training for the in-house management of the portal. The last part of API documentation was created by the Nova Poshta developers and just verified by us. After training for system administrators and business owner we released the portal.
Collaboration with outside API developers was brought to the new quality level. Before portal API docs were distributed as pdf files leading to the outdated info and poor experience. Now Developers Portal offers even video guides and means to report defects and to request support and consulting. Needless to say that Developers Portal is a single up-to-date source of information about Nova Poshta API.
One of the best features offered by Azure API Management portal is interactive documentation. Developers that used to read pdf documentation now have the ability to fire API calls right from the browser on the portal. They see the structure of requests and responses live. They have samples of code for invocation in several programming languages.
The new API web portal has become much more interactive and more convenient. Now developers are able to test the code online, right in their browser, there also appeared videos that explain the principles and specifics of work, – says Andriy. – All these novelties have greatly reduced customers’ time spent for integration with Nova Poshta systems.
CIO Nova Poshta
Please read case study at Microsoft Ukraine
Microsoft Azure API Management, Microsoft Azure, JSON,
1 API Architect
1 Business Analyst
1 Project Manager
From start to finish this project took only 40 days with the modest budget in the frame of Microsoft Enterprise Agreement.
After one year of the API management portal being online, I can see by all metrics that this was a very right decision and a big success. We see the huge increase in traffic to the portal. We see less inbound requests to helpdesk about API. We spend less time to manage API documentation. We have very positive feedback from our key clients after they started using our Nova Poshta Developer Portal.
Head of Digital Product Development Department, Nova Poshta