The API Publisher Newsletter vol 2 — best practices, tools + more

In this month’s edition of the Postman newsletter for API publishers, we’re showcasing the top-performing APIs on the Postman API Network along with the latest ways to leverage the Network to build your dev community, communicate key changes, and drive adoption of your APIs.

We’ll dig into how top publishers like Tomorrow.io are inspiring users with use cases and recipes on their dev portals with Run in Postman Buttons, and how Mastercard empowers their developers by guiding them through payload encryption using Postman Scripting. Finally, don’t miss our newest feature Workspace Updates—new tools for communicating key API content and information to your developer community.

Let’s dive in :point_down:

Learn from the top publishers

Each month we look at the fastest growing collections on the Network and share key lessons any publisher can take away from these high performers. Let’s explore what we can learn from this month’s leaders:

Zoom — Zoom is a leading platform for video communications and collaboration. On the Postman API Network, they provide a “Getting Started” collection to help onboard users and enhance the developer experience. Learn more about creating Getting Started workflows and why these are a best practice for a top-performing public workspace.

HubSpot — HubSpot is a powerful CRM platform that supports marketing, sales, customer service, and operations. They offer a wide range of collections on the Postman API Network for each of their services and feature a landing page on their website dedicated to these Postman collections. This kind of landing page is a great way to ensure developers get up-and-running quickly with all the right resources.

Oracle Hospitality — Oracle Hospitality delivers cloud-based solutions designed specifically for the hospitality industry, helping hotels, restaurants, and venues enhance guest experiences and streamline operations. They host an on-demand video webinar demonstrating how to use their APIs with Postman collections.

Publisher Inspiration

Tomorrow.io demonstrates Uses Cases with ReadMe Recipes and Postman

Tomorrow.io, a weather intelligence platform that provides hyper-local, real-time weather data and forecasts, wanted to showcase more in-depth workflows for their weather intelligence API, aiming to create a lab-like experience on their developer portal where users could follow along and interact with real-world examples.

To achieve this, they integrated Run in Postman buttons on their ReadMe-powered Recipes in their documentation portal, allowing developers to explore use cases beyond basic reference documentation. By leveraging ReadMe’s Postman integration, Tomorrow.io transformed its portal into an interactive environment, with workflows structured as recipes, guiding users seamlessly from documentation to hands-on experimentation in their Postman workspace. Discover how Tomorrow.io highlights API capabilities while simplifying consumer onboarding — an invaluable model for enhancing developer experience!

:point_right: Create your own Run in Postman Button now

Mastercard Uses Scripts to demonstrate data preparation for requests

Mastercard, a global leader in payment solutions, demonstrates how publishers can use Postman scripting to securely handle sensitive data with third-party encryption libraries. API users may require guidance on preparatory code steps, such as data transformation, formatting, or, in this case, encryption, before making an API request. In this guide, Mastercard shows how to sideload an open-source encryption library directly into Postman, enabling users to encrypt and decrypt request and response bodies for secure testing.

By setting up pre-request scripts and configuring environment variables, Mastercard provides a streamlined approach for securely testing APIs with sensitive data. This example shows API publishers how to use Postman’s scripting features to create hands-on, secure workflows that guide users in protecting data and understanding key encryption practices.

:point_right:Learn more about scripting in Postman

New on the Network: Public Workspace Updates

You can now publish updates directly to watchers of your workspace, making it easier to engage with your developers and keep them up-to-date. Whether you’re announcing a new version, a hotfix, or something cool, this feature enhances your ability to communicate with your community — and comments and reactions mean they can let you know how they feel :clap: See a live example here.

To publish an update, navigate to the new Updates section of your Workspace home:

Workspace Updates

And be sure to check your Public Workspace Metrics to see how your updates impact views, forks, and API calls. Going forward, watchers will no longer receive one-off emails each time you edit your collections. With Public Workspace Updates, you can now choose when and what they will receive, allowing you to craft engaging announcements and ensure your users get only high-quality content.

Publisher Connect Meetups

We’ve recently launched monthly virtual meetups for publishers on the Postman API Network! These meetups are focused on learning from other Publishers and the Publisher Success team.

Here’s what you can look forward to each month:
:handshake: Connect with fellow publishers
:mortar_board: Learn from shared experiences and best practices
:bulb: Share your ideas and insights
:sparkles: And much more!

Spaces are limited, so be sure to register for our waitlist to learn about the next meetup. Join the waitlist here.

10 Likes

I absolutely love the way these companies are building collections. An integration is rarely complete with a single endpoint. Rather, it’s several endpoints in a specific order carrying data from one call to the next.

Building collections that demonstrate business scenarios rather than “here’s what our API is” is HUGE! I love the enablement y’all are pushing and how much easier this is going to be for developers.

Also, the public workspace metrics are perfect for customer-led development. Imagine you have 10 collections in your workspace and they get a combined total of ~5k views and 100 forks a month. But then you publish a new (use case based) collection that gets 5k views and 500 forks a day on its own and you immediately know where you should be investing your time. Metrics like this are seriously underrated.

It’s hard to get direct user feedback, and usage-based statistics speak volumes.

Love what you guys are doing for publishers!!! :blue_heart:

4 Likes

Thanks for the kind words, Allen!

Really love your thoughts on customer-led development and how to leverage workspace metrics to that end — very insightful.

Wanted to tag-in Steve (@altimetry-engineer12) who’s PMing Publisher Tooling, which includes use cases for metrics like this, in case he has any thoughts or questions for you.

Thanks again for sharing :pray:

1 Like