Nova Poshta Developers Portal for API Documentation

Was ist das?

Das Nova Posta Developers Portal ist eine Website für die interaktive API-Dokumentation der Firma. Sie wurde mit dem Azure API ManagementProduct erstellt und bietet Entwicklern alle Werkzeuge, die sie brauchen, um komfortabel mit den APIs der Firma zu arbeiten. Zusätzlich zur API-Dokumentation ermöglicht das Portal technische Unterstützung und Beratung durch die API-Entwickler von Nova Poshta. Weiterhin können  API-bezogene Nachrichten und Ankündigungen eingestellt werden. Das Portal ist seit über einem Jahr online und hat in dieser Zeit viel positives Feedback aus der Entwicklergemeinschaft erhalten.

Nova Poshta Developers Portal for API Documentation

Unsere Beiträge

Wir hatten das Ziel, die Arbeit von Nova Poshta im Hinblick mit Dokumentation und Kommunikation in der Entwicklers-Community so schnell wie möglich zu ändern. In der ersten Phase haben wir existierende Lösungen auf dem Markt für API-Management evaluiert. Unter den vielen möglichen Lösungen, einschließlich kundenspezifischer Entwicklungen, haben wir die Lösungen von Microsoft aus folgenden Gründen bevorzugt:

Nova Posta hat eine Unternehmensvereinbarung mit Microsoft.

– Microsoft bietet ein API-Verwaltungsportal aus seiner Cloud Azure auf Abonnementbasis an.

– Das Produkt umfasste alle benötigten Funktionen.

– Wir haben mit diesem Produkt die beste Zeit für die Markteinführung erwartet.

Nachdem das Produkt ausgewählt wurde, entschieden wir, zunächst einen Prototypen zu erstellen, der dann bewertet, überarbeitet und schließlich freigegeben werden sollte. Wir haben eine Pilot-Installation des Portals mit einer Teilmenge von APIs erstellt. Nach der erfolgreichen Evaluierung begleiteten wir Nova-Posta-Entwickler bei der Erstellung der Dokumentation für einen anderen Teil der API-Dokumentation und bildeten so Leute für das interne Management des Portals aus. Der letzte Teil der API-Dokumentation wurde vonNova-Poshta-Entwicklern erstellt und von uns verifiziert. Nach einer Ausbildung für Systemadministratoren und Unternehmer gaben  wir das Portal schließlich zur Verwendung frei.

Die Qualität der Zusammenarbeit mit externen API-Entwicklern wurde deutlich verbessert. Die Verteilung von Portal-API-Dokumenten als PDF-Dateien hatte immer wieder zu veralteten Informationen und schlechten Erfahrungen geführt. Heute hingegen bietet das Entwickler-Portal sogar Videositzungen und Kanäle für die  Meldung von Mängeln und zum Verfassen von Support-Anfragen. Selbstverständlich ist dieses Entwickler-Portal eine einzelne aktuelle Informationsquelle über API von Nova Poshta.

Nova Poshta Developers Portal for API Documentation. Syndicode

Eine der nützlichsten Funktionen des Azure API Management-Portals ist die interaktive Dokumentation. Entwickler, die früher PDF-Dokumente lasen, können nun API-Aufrufe direkt über den Browser im Portal auslösen. Sie sehen die Struktur von Anfragen und Antworten live. Sie bekommen Codebeispiele für den Aufruf in verschiedenen Programmiersprachen.

Nova Poshta Developers Portal for API Documentation. Syndicode

Das neue API-Webportal ist viel interaktiver und komfortabler geworden. Nun sind Entwickler in der Lage, den Code  online zu testen, direkt in ihrem Browser, wo auch Videos zur Verfügung stehen, die die Grundsätze und Besonderheiten der Arbeit erklären. Alle diese Neuerungen reduzieren maßgeblich die Zeit, die Kunden für die Integration mit Nova-Poshta-Systemen benötigen.

nova-poshta-img-12

Andrii Pokotilov
CIO Nova Poshta

Nova Poshta Developers Portal for API Documentation. Syndicode

Technologien

Microsoft Azure API Management, Microsoft Azure, JSON,
REST, XML

Nova Poshta Developers Portal for API Documentation. Syndicode

KUNDENSTANDORT

Kiew, Ukraine

SYNDICODE TEAM

1 API-Architekt

1 Business Analyst

1 Projektmanager

ZEITLEISTE

Mai 2015

Highlights

Das Projekt  dauerte nur 40 Tage von Anfang bis Ende und wurde durchgeführt mit einem bescheidenen Budget im Rahmen des Microsoft Enterprise Vertrags.

Nova Poshta Developers Portal for API Documentation. Syndicode

Testimonial

Nach einem Jahr, in dem das API-Verwaltungsportal online ist, kann ich anhand aller Messwerte feststellen, dass dies eine sehr richtige Entscheidung und ein großer Erfolg war. Wir sehen den enormen Anstieg des Traffics zum Portal. Wir sehen weniger eingehende Anfragen an den Helpdesk zur API. Wir verbringen weniger Zeit mit der Verwaltung der API-Dokumentation. Wir haben sehr positives Feedback von unseren wichtigsten Kunden erhalten, nachdem sie unser Nova-Posta-Entwicklerportal genutzt haben.

Artyom Volkhonskyi
Leiter der Abteilung für digitale Produktentwicklung, Nova Poshta

Nova Poshta Developers Portal for API Documentation