Western Union Reveals How Use Instances Make for a Nice Developer Expertise
In case your group offers APIs, the success of these APIs will depend on how nicely your API developer portal highlights and explains them. Present and future stakeholders will go to your API developer portal to study all the things attainable about your API(s) and even your organization, each from a technical standpoint and likewise simply as importantly, from a enterprise standpoint. How do you make it possible for your developer portal is best-in-class? There are a variety of sides that go into the main API portals and ProgrammableWeb has written a collection of articles that will help you perceive what finest practices are being utilized by the highest suppliers.
The preliminary article on this collection offered a complete guidelines of the standards wanted to construct a world-class API developer portal. Subsequent Editor’s Selection articles together with this one will present a extra in-depth take a look at how particular person API suppliers have executed on the assorted standards.
In the present day we’re wanting on the cash switch and funds providers firm Western Union and the way it leverages use circumstances to enhance the Developer Expertise (DX) for guests to its API portal.
In our guidelines article, we mentioned the significance of explaining the enterprise case on your API to a choice maker who could also be studying about your API for the primary time. Going past this, one confirmed methodology of participating with this viewers is to point out instance use circumstances that handle how your APIs can remedy a developer’s particular issues. Fastidiously thought out use circumstances have the power to work not just for an executive-level viewers, but in addition for guests who work at a product stage and who’re hoping to grasp the entire potentialities enabled by your APIs. The descriptions for the use circumstances don’t should be lengthy, however they do have to give attention to outcomes versus itemizing a set of options. If a consumer is visiting your portal for the primary time and isn’t fairly certain what your API does or why they need to use it, you want to have the ability to inform them a brief story that convinces them that you simply perceive the house nicely and are finest positioned to assist them.
We should always take a second to debate the distinction between a use case and a case examine. A use case needs to be basic in nature. It ought to reference how the API may also help builders with their issues, and the outcomes that may be enabled by the API. It shouldn’t nonetheless be particular to 1 buyer’s API expertise. Case research then again are supposed to deliver buyer tales to life together with the challenges they had been dealing with, the options they turned to, and the enterprise outcomes (qualitative or quantitative). We have now beforehand coated how Twilio’s case research are finest at school.
Western Union’s developer portal highlights the provision of its use circumstances proper on it’s house web page. Beneath a banner and an announcement that makes the enterprise case for the API is a graphic providing hyperlinks to a few full use circumstances after which two extra hyperlinks that cowl extra use circumstances. In complete, Western Union has seven completely different use circumstances for customers to discover. The truth that Western Union has devoted this a lot actual property to its use circumstances is a sign that it understands the necessity to educate choice makers about its API.
Determine 1 The Western Union developer portal touchdown web page highlights 5 use circumstances for its API
The 2 methods to current use circumstances are to offer a abstract or a bullet listing on the portal house web page that touches on the ways in which your API can remedy the issues a developer might face, or ideally to write down a extra detailed narrative that resides by itself web page. When you select the second method, then you will want to present the consumer a transparent technique to discover them both by means of hyperlinks on the web page or throughout the portal’s navigation.
Determine 2 Western Union offers a quick and to the purpose final result for real-life use circumstances of the API together with enticing graphics.
Western Union presents every use case with a constant, templated format. On the high of every web page is a banner picture, the identify for the use case and a brief description. The outline describes the expertise that’s enabled for patrons by means of using the API utilizing language that’s concise and clear making it simple for choice makers to grasp the worth.
Beneath the banner is extra textual content, restating the use case if the consumer missed it within the banner. Under the textual content is among the extra distinctive options we have now come throughout. Western Union has chosen to point out the shopper’s journey by means of using a gorgeous step-by-step set of graphics with accompanying textual content. This remedy simplifies the use case into a simple to comply with workflow that would simply resemble the identical enterprise course of at another firm. In consequence the use circumstances are delivered to life in a method that we’ve hardly ever if ever seen.
Determine three Every use case is summarized with key advantages and a hyperlink to how companions had been enabled by them
Every use case concludes with a abstract of key advantages. Right here we begin to see extra point out of options as a substitute of buyer outcomes however, by this level it feels acceptable. A number of the use circumstances additionally hyperlink to a buyer story with extra particulars about how companions had been enabled by the API. This can be a good thought and needs to be normal for an API portal. Ideally, a supplier ought to have a case examine for every use case.
Use circumstances are an usually uncared for a part of API developer portals. However, they could be a fast and efficient technique to interact with choice makers. At a naked minimal, all portals ought to have a set of use circumstances even when they’re little greater than summaries. Western Union has created among the best units of use circumstances that we have now come throughout. It has taken the time to obviously lay out the real-world situations enabled by its API which permits choice makers to see how their issues are addressed. For these causes, ProgrammableWeb wish to give an Editor’s Selection Award for excellence in Developer Expertise (DX) to Western Union.