November 2021 Summaries

In the final installment of a three-part series, the article explores the advanced features of the Postman API Platform and its application in the healthcare and insurance industries, following previous discussions on finance, retail, automotive, and technology sectors. The use of mock servers in Postman helps provide easy access to sample API data without requiring users to register for API keys, facilitating lower barriers to entry for demos. Additionally, Postman's visualization capabilities enable the transformation of API data into human-readable formats, enhancing accessibility for non-developer team members, as demonstrated in a health dashboard and insurance UI prototype. In the healthcare sector, the focus was on creating a workspace that integrates the FHIR specification and includes tools like the Lifepack and Commure APIs, addressing information security through careful management of sensitive data. The insurance industry demo workspace centered on transitioning from a monolithic claims API to microservices, utilizing the Open Insurance API standard and integrating with external APIs, such as Mercedes-Benz's Pay As You Drive Insurance API, to showcase potential business models. The article concludes by encouraging readers to explore these features and share their industry-specific insights.

Postman's API testing capabilities have been significantly enhanced with the introduction of the new Postman API Platform, which integrates seamlessly into existing workflows while utilizing familiar CI/CD tools. The platform allows users to maintain API-first testing through Postman Collections, which include documentation, mock servers, and test suites, synchronized with the repository, facilitating tests without leaving Postman's interface. By employing tools like Postman's collection runner and the command-line tool Newman, tests can be executed across various environments and integrated within CI/CD systems like CircleCI and TravisCI. This integration allows developers to monitor and trigger builds directly from Postman, providing a consolidated view of build status across branches. The system supports real-time collaboration on API interfaces, and updates are automatically reflected in the CI/CD pipelines, offering a streamlined approach to maintaining API quality. The platform also encourages feedback for further enhancement and supports other CI providers to align with diverse testing workflows.

The Postman API Platform introduces a comprehensive approach to API-first development, allowing developers to treat APIs as holistic entities rather than disparate components. This platform supports API-centric workflows, enabling teams to integrate development, testing, monitoring, and deployment phases seamlessly. By using Postman as the source of truth for APIs, teams can implement versioning strategies and continue utilizing familiar tools, enhancing collaboration and efficiency. The platform encourages viewing the API as a unified construct, incorporating code, definitions, collections, and tests into a single workflow. It offers features such as server boilerplate generation, real-time collaboration, and integration with version control systems like GitHub, Bitbucket, and GitLab. Postman's versioning capabilities allow for the management of multiple API versions, facilitating parallel development and deployment. The platform aims to empower teams with API-first superpowers, refining the API development process and fostering better alignment with testing workflows.

Postman introduces a new WYSIWYG (What You See Is What You Get) editor for documenting collections and APIs, aiming to integrate documentation into the workflow rather than being an afterthought. This editor eliminates the need for markdown, simplifying the process of creating descriptions, particularly for complex content like tables, images, and code. Users can style and format text interactively without previewing changes, and the editor supports both markdown triggers for experienced users and common shortcuts for those familiar with traditional editors, all accessible via a toolbar. The editor ensures backward compatibility, allowing existing markdown documentation to be used without modification, and Postman plans to expand this user-friendly editing experience based on feedback.

Debugging in programming, especially for APIs, involves identifying and resolving code errors by increasing visibility into the process. Key methods to enhance API debugging include using Postman as an API client to manipulate inputs and inspect outputs, utilizing the Postman console to view network calls and log errors, and employing mock servers to simulate API behavior and isolate test systems. These techniques help explore API behavior, troubleshoot unexpected issues, and establish monitoring and alert systems. A recent Postman Intergalactic session highlighted these methods and recommended strategies, offering insights into advanced API debugging practices, with further learning resources available through recorded sessions and upcoming events.

This text discusses the use of Postman in creating industry-specific demo workspaces to demonstrate how organizations can leverage its features for API development and management. It highlights the importance of APIs in Postman, providing insights into building, documenting, and testing APIs within demo workspaces, specifically for the finance and retail industries. The finance workspace focuses on maintaining security and compliance while ensuring a smooth developer experience, using features like token management and mock servers. In contrast, the retail workspace addresses transitioning from monolithic to microservice architectures to improve API accessibility and consumption. The text emphasizes the significance of well-documented APIs and collections, using Postman features such as the Private API Network and visualizers to facilitate easier navigation and consumption. It also underscores the dual benefits of thorough documentation, which not only aids in internal resource discovery but also prevents redundant efforts. The article encourages readers to apply these strategies within their own teams and invites them to share their unique uses of Postman features.

Anna Tsolakou, a developer advocate at Amadeus, outlines a step-by-step guide for using Amadeus Self-Service APIs to book flights through the Postman application. The process involves obtaining an Amadeus API key, which is necessary to access the APIs, and using Postman to search for flights, confirm their prices, and finalize bookings. The guide emphasizes the use of three interconnected APIs: Flight Offer Search to locate flights, Flight Offer Price to verify fare availability and pricing, and Flight Create Orders to complete the booking process and obtain a booking reference number. It also highlights the ease of integrating Amadeus APIs into applications, enabling developers to swiftly access functionalities like flight and hotel bookings, or COVID-19 travel restriction data. Once familiar with the process, users can implement these functions in their own programming environments, further exploring Amadeus' API offerings for additional travel-related services.

APIs are integral to organizations across various industries, and managing an API ecosystem requires strategic oversight to ensure success in today's dynamic business environment. The Postman Open Technologies program aims to enhance API practices by coaching leaders on effective management and governance through the concept of mapping. This approach, based on the 10 pillars outlined in O’Reilly’s Continuous API Management book, includes key aspects like strategy, design, documentation, development, testing, deployment, security, monitoring, discovery, and change management. By creating a simplified map of the API ecosystem, organizations can assess their strengths and weaknesses, allowing them to focus on the most impactful areas for improvement. This visual representation fosters meaningful conversations about alignment and gaps within the organization, ultimately guiding the optimization of the API program toward more intentional and effective operations.

Postman Intergalactic offers a new role-based training series focused on hands-on learning experiences about API development and documentation. The series streams live lessons, which are also available on demand, and covers essential topics like API testing, designing, and documentation, emphasizing the importance of good documentation for enhancing user experience and API adoption. The series includes a two-part miniseries specifically for API publishers, with the first part focusing on documentation best practices and using the OpenAPI Specification to generate documentation, and the second part exploring strategies to increase public API adoption. This comprehensive training is led by Postman experts and aims to equip participants with the skills to improve API consumer experiences, offering resources like forkable collections and video walkthroughs to facilitate learning at one's own pace. Upcoming sessions, such as "Introduction to API Security," provide ongoing opportunities for participants to expand their knowledge in various aspects of API management.

APIs are increasingly integral across various industries, prompting the Postman solutions engineering team to create a series of demos using fictional companies to illustrate how users of the Postman Enterprise plan can address industry-specific challenges. The team developed demos based on research and firsthand experiences, highlighting key features such as user provisioning through SCIM API, user groups for permission management, and the Private API Network for organized API sharing. These features are beneficial for large organizations, ensuring efficient account management and collaboration while maintaining security and data privacy. In the automotive industry, Postman helps manage the integration of car sensors and data privacy, while in the technology sector, it focuses on enhancing developer experience and governance through consistent API patterns and documentation. The blog series aims to provide insights into how different industries can utilize the Postman platform effectively, with future posts planned to cover additional sectors like healthcare, retail, finance, and insurance.

Lauren Schaefer's guest post provides a detailed guide on using the MongoDB Atlas Administration API through Postman. MongoDB Atlas, a multi-cloud document database service, offers an Administration API for programmatically managing database deployments, users, and monitoring, which is particularly beneficial for CI/CD pipelines and developer portals. Cassiano Ziegler Bein, a MongoDB Senior Solutions Architect, has created a Postman Collection that includes requests for every endpoint in the Atlas API, enhancing user interaction with the API. The post walks readers through setting up a database deployment in MongoDB Atlas, creating an API key, and configuring Postman to make API requests. It emphasizes the use of the Postman Collection to explore and utilize various API endpoints, with details on how to authenticate and manage requests. The post invites readers to an upcoming livestream event to learn more about automating tasks using the Atlas API and encourages participation in the MongoDB Community for further inquiries.

AsyncAPI is a specification designed to define event-driven architectures, providing a machine-readable specification and necessary tooling to support diverse APIs within enterprises. Created as a companion to the OpenAPI specification, AsyncAPI aims to address the needs of event-driven APIs, gaining support from platforms like Postman. The specification facilitates the management of complex microservices by using events to trigger and communicate between services, and its adoption is supported by a robust community and open-source tools such as parsers, code generators, and visual studios. The AsyncAPI team's approach emphasizes radical transparency and community involvement, with resources like a comprehensive website, active GitHub organization, and community channels like Slack and YouTube for feedback and collaboration. The specification's success is also bolstered by financial backing through platforms like Open Collective, and its integration into the Linux Foundation, underscoring the importance of open-source contributions in evolving the specification to meet modern API needs.

After initially being skeptical about puzzles, the author was inspired by their team's enthusiasm during a virtual escape room challenge, leading them to create "Lost in Space," a puzzle game designed for API enthusiasts. The game involves helping six International Space Station members return to orbit after a solar flare by solving clues, with a recommended team size of one to six players and an estimated duration of two to four hours. The challenge is suitable for individuals with basic web API knowledge, and teamwork is encouraged to leverage diverse skills and perspectives. Participants can access clues via a public workspace, and upon solving the puzzle, they can validate their solution with Mission Control to earn a badge and a place on the leaderboard. The experience offers a unique blend of fun and learning, with additional options like Postman IQ trivia and various training badges for those interested in expanding their skills.

Postman's API-first student event for Hacktoberfest encouraged students to engage with API development by participating in a Halloween Costume Contest API challenge, where they could choose to build either a frontend or a backend. The API-first approach involved defining an API before any server or frontend code was written, using the OpenAPI Specification 3.0 to create a schema. Throughout October, students received support from Postman's team and the Student Community Discord, allowing them to work on projects individually or in teams. Participants used various tech stacks, including Node/Express, MongoDB, and React, to fulfill the challenge requirements. Harikrushn Kanani stood out by submitting both frontend and backend projects, and the raffle winner was Sourav Kumar Swain, who completed the backend challenge. The event was highlighted by regular interactions and assistance, culminating in a digital raffle with a US$250 Amazon gift card awarded to the winner.

In August 2021, the Postman Student Programs team hosted the inaugural global Postman Student Summit, marking the world's largest API conference for students and educators with over 6,000 participants from more than 100 countries. The two-day virtual event featured prominent sessions, including a fireside chat with Postman Co-founder and CEO Abhinav Asthana, who discussed his journey and vision for promoting API knowledge among students, and a keynote by Co-founder and CTO Ankit Sobti on the evolving role of APIs as products. The summit also included diverse presentations from industry experts, students, and educators, highlighting topics such as data analysis, serverless APIs, machine learning, and API-first curricula. The event was supported by community partners like Girlscript Foundation and Hack Club, and concluded with a student hackathon showcasing innovative uses of Postman Visualizer. The summit was celebrated as a major success, with plans already in place for a follow-up event the next year.

Git is widely used as a version control system to manage changes in technology projects, and Postman has integrated Git workflows to enhance collaboration on API development. Through the use of features like forking, merging, and pull requests, Postman allows teams to manage both real-time and atomic updates, ensuring that changes are carefully controlled to prevent disruption to workflows. Users can create workspaces, connect repositories, and manage API specifications as the single source of truth, or alternatively use collections if API specifications are not employed. The platform supports roles with varying permissions for enhanced security, and allows for public and private collaboration on APIs, catering to diverse workflow needs. Postman distinguishes between version control, which is about managing changes collaboratively, and versioning, which involves tracking changes over time, offering tools to handle both aspects efficiently.

Postman has emerged as a pivotal tool for developers, offering a comprehensive API platform to streamline the entire API development lifecycle, from design to deployment, managing over 17 million users globally. The company identified a gap in API discovery, addressing it by introducing the Postman Public API Network and a universal search feature aimed at improving API accessibility and collaboration. This development involved significant engineering efforts, including the selection of Elasticsearch for data indexing and the creation of a robust data pipeline to support real-time search capabilities. Postman’s approach to product development is methodical, involving phases like MVP, growth, and maturity, as the team focuses on refining their offerings based on user feedback and market needs. The introduction of cross-ranking algorithms has enhanced search functionality by prioritizing relevant elements, and future plans include integrating machine learning to further refine search accuracy. As Postman continues to innovate, its universal search is poised to become an essential tool for the global API community, facilitating efficient API discovery and interaction.