API publishers amongst Postman’s neighborhood of greater than 15 million are working towards extra seamless and built-in developer experiences for his or her APIs. Distilled from a whole bunch of one-on-one discussions, I lately shared a research on increasing adoption of an API with a public workspace in Postman. One of many greatest causes to make use of a public workspace is to reinforce developer onboarding with a quicker time to first name (TTFC), a very powerful metric you’ll want for a public API.
If you’re not investing in TTFC as your most vital API metric, you might be limiting the scale of your potential developer base all through your remaining adoption funnel.
To know a developer’s journey, let’s first check out elements influencing how a lot time and power they’re prepared to put money into studying your know-how and making it work.
- Urgency: Is the developer actively trying to find an answer to an current drawback? Or did they hear about your know-how in passing and have a light curiosity?
- Constraints: Is the developer making an attempt to satisfy a deadline? Or have they got limitless time and price range to discover the chances?
- Alternate options: Is the developer required by their group to make use of this answer? Or are they selecting from many suppliers and contemplating different methods to unravel their drawback?
Developer journey to an API
With that context in thoughts, the next phases describe the developer journey of encountering a brand new API:
Step 1: Browse
A developer browses your web site and documentation to determine what your API affords. Some individuals gloss over this step, preferring to study what your tech affords interactively within the subsequent steps. However judgments are fashioned at this very early stage, doubtless whereas evaluating your product amongst options. For instance, in case your documentation and onboarding course of seems comparatively unorganized and riddled with errors, maybe it’s a reflection of your know-how.
Step 2: Signup
Signing up for an account is a developer’s first dedication. It alerts their intent to do one thing along with your API. Regularly going hand-in-hand with the subsequent step, signing up is required to generate an API key.
Step 3: First API name
Making the primary API name is the primary payoff a developer receives and is oftentimes when builders start extra deeply understanding how the API matches into their world. Stripe and Algolia embed interactive guides inside their developer documentation to allow first API calls. Stripe and Twitter additionally use Postman public workspaces for interactive onboarding. Since many builders already use Postman, experiencing an API in acquainted territory will get them one step nearer to implementation.