How to Successfully Market an API
How to Successfully Market an API
Fine-Tuning Developer Relations & Platform Advocacy
About the Book
In the widening API sphere, marketing an API business involves knowing your customer intimately, and fine-tuning your developer support channels to help users excell. From evangelism, advocacy, to community building - the job of promoting a developer-centric program (and doing it tastefully), now needs its own strategy.
This eBook is structured into four parts. We first we walk through a Planning stage with tips on starting your program, understanding your target consumer, market research, and more using the API canvas model to position your agile API business. Next, we discuss Developer Relations with tips on onboarding and quality developer experience when it comes to overall API design as well as documentation and developer portal resources. Next, we cover tips on Promotion, outlining API discovery techniques and relevant press resources that will help spread awareness of your product, as well as ideas for creating evergreen content for blog publishing that informs and engages API users. Our last section on Advocacy defines the roles of program evangelists, tips on holding your own developer conferences, as well as case studies into failures and successes companies have had with public API programs in recent years.
If you are a project manager assigned to marketing an API, here is your bible.
About the Author
About the Contributors
Editor in Chief @ Nordic APIs
Bill Doerrfeld is a technologist and writer interested in disruptive software and projecting technology of the future. He is especially devoted to tracking the API economy, and is the Editor in Chief for Nordic APIs, a blog and knowledge base devoted to helping API (Application Programming Interface) providers refine their platforms. Follow him on Twitter, Linkedin, or reach out via email. Visit doerrfeld.io for more.
API Specialist
Chris Wood is an API specialist from the UK. His main interests are API management, Python and working on cool and interesting stuff. Connect with Chris on Twitter.
Jarkko Moilanen is a long term open source community activist, creator of the APIOps concept and founder of the API-Suomi community. Jarkko is one of the leading API economy evangelists (APItalist) in Finland. Nowadays designing and leading strategy implementation in education and cloud services at Ministry of Education and Culture. Also acting as one of the X-Road Ambassadors in Finland and Joint X-Road community midwife.
Blogger @ Nordic APIs
Kristopher Sandoval is a web developer, author, and artist based out of Northern California with over six years of experience in Information Technology and Network Administration. He writes for Nordic APIs and blogs on his site, A New Sincerity.
Host and Producer of the public speaking podcast Time to Shine. Oscar has spent more than three years as a Product Manager in the software industry. Either onstage or on blogs he advocates making technical presentations and product demos that engage and inspire.
Chief Architect, Oxygis
Vassili van der Mersch is a technology entrepreneur and freelance programmer from Belgium. He is the founder of Sevendays, the Chief Architect at an Internet of Things company called Oxygis and formerly a manager at Accenture, where he worked as a technology consultant for 10 years. Throughout his career in consulting, he has worked on a variety of API backends for large organizations in government and financial services.
Table of Contents
-
- Preface
-
Part One: Planning
-
Building from the Ground Up: Tips for Starting Your API Program
- Clarify Your Needs
- Get Buy In (From Everyone)
- Aim for a Public MVP
- Act on Feedback
- Build your Practice
- Final Thoughts
-
Define Your Target Developer Audience
- Why Create a Developer “Persona”?
- The Developer Brain
- But Plenty of Other People Are Interested in APIs, Too!
- Expanding our Portal: Developer End User Evangelism
- Varying Industry Backgrounds
- Location & Demographics
- API Use Cases
- Technology Preferences
- Lessen The Corporate Branding
- Developer Experience
- Build it And They Will _____
- Understand Your Audience
-
Developer Experience is a Key Ingredient of Quality APIs
- API Model Canvas – offspring of Lean Canvas
- Developers are the Rockstars of the API Economy
- Addressing the Entire API Model Canvas
- Case Study: National Library of Finland
- MVP for next step
- Gain speed and make it fun
- Final Thoughts
-
Building from the Ground Up: Tips for Starting Your API Program
-
Part Two: Developer Relations
-
Ingredients That Make Up a Superb Developer Center
- Getting Started Guide
- Authentication Guide
- API Documentation
- Testing Environment
- Developer Resources
- Support Channels
- Platform Policy
- Cater Your Home Presence to Non-Developers Too
- Final Thoughts
-
Crafting Excellent API Code Tutorials that Decrease On-boarding Time
- Setting the Context
- Exploring the Details
- Creating an Application
- Final Thoughts
-
What is the Difference Between an API and an SDK?
- Define: API
- Define: SDK
- Squares and Rectangles
- Examples
- Apples and Oranges
-
Developer Resources: SDKs, Libraries, Auto Generation Tools
- What Are Helper Libraries?
- Why Not Just Let Them REST?
- Data Problem
- Programming Language Trends
- Discover What Languages Your Consumers are Using
- Who Should we Model?
- HTTP is Language Agnostic
- 5 Tips for Helper Library Design
- Last Line of API Code: Your API is Never Really Finished
-
A Human’s Guide to Drafting API Platform Policy
- Key Themes
- Defining Responsibilities
- Setting Expectations
- Describing Good Behaviors
- Final Thoughts
-
Creating A Brand Guide for Your API Program
- Platform Strategy Dictates Brand Requirements
- Brand Guide Components
- Formatting Your Design Guide
- The Effect of Zero or Poor Branding Guidelines
- Final Thoughts
- Examples of API Branding Guides in the Wild:
-
Ingredients That Make Up a Superb Developer Center
-
Part Three: Promotion
-
Perfecting Your API Release
- What do I release?
- Time Your Release
- Widen Your Potential Audience
- Have the Right Monetization plan
- Have a Demo
- Have Awesome Branding
-
Tips to Make Your API More Discoverable
- SEO Approach: Optimization of API Homepages
- Service Discovery Automation
- Cheat Sheet of 10+ API Directories to Submit Your API to
-
Important Press Networks and Developer Channels in the API Space
- Press Release Distribution
- API-Specific Blogs, Thought Leaders, and Digests
- General Tech & Developer News
- Nordic Tech Press/News
- Social Bookmarking
- API Events
- The Everpresent Commentator
-
Utilizing Product Hunt to Launch Your API
- Alpha, Closed Beta, Open Beta, or Full Release?
- Preparing for a Release
- Offering Exclusive Deals: The Gold Star
- Actually Submitting a Profile on Product Hunt
- The Launch: Introduce Yourself, Play Nice, Get the Word Out
- The Unanticipated Launch
- The Return on Investment
- The Internet’s Watercooler is Product Hunt
- Resources
-
Perfecting Your API Release
-
Part Four: Advocacy
-
Day in the Life of an API Developer Evangelist
- 8 Important Job Roles of a Software Evangelist
- What does an Evangelist do each day?
- Evangelism vs Advocacy
- Q&A Section
- Conclusion
- Interviewees:
-
How to Offer Unparalleled Developer Support
- The Importance of Developer Outreach
- Email and Social Media
- Event Hosting and Attendance
- Documentation and Knowledge Bases
- Conclusion
-
Accumulating Feedback: 4 Questions API Providers Need to Ask Their Users
- Why Feedback is Important
- What Do You Expect From This API?
- What Is Your Greatest Frustration with the API?
- Why Did You Choose Our API?
- If You Could Change Our API, How Would You?
- Methods to Use for Accumulating Feedback
- Think As a User
-
How to Hold a Killer First Hackathon or Developer Conference
- Types of Get-Togethers
- What is a Hackathon?
- What is a Developer Conference?
- What’s the Difference?
- How to Host an Event
-
What Makes an API Demo Unforgettable?
- 1: Describe the API, in a few words.
- 2: Convince we all share the same values of the API
- 3: Impress with how great and easy your API is
- 4: Interact with the audience
- 5: Live coding mastery
- 6: A theater-like script
- Preparation for potential technical flaws
- Conclusion
-
Case Study: Twitter’s 10 Year Struggle with Developer Relations
- 2006 - 2010: The early days
- 2010 - 2012: OAuthcalypse, competing with third party apps and other perceived betrayals
- 2012 - 2013: Token limits and open war on traditional clients
- 2013 - Present: Post-IPO controversies
- Wooing back developers
- New releases and optimism going forward
- Other social networks
-
Day in the Life of an API Developer Evangelist
-
Review
- TL;DR Checklist
- Endnotes
The Leanpub 60-day 100% Happiness Guarantee
Within 60 days of purchase you can get a 100% refund on any Leanpub purchase, in two clicks.
See full terms
Do Well. Do Good.
Authors have earned$12,143,754writing, publishing and selling on Leanpub, earning 80% royalties while saving up to 25 million pounds of CO2 and up to 46,000 trees.
Learn more about writing on Leanpub
Free Updates. DRM Free.
If you buy a Leanpub book, you get free updates for as long as the author updates the book! Many authors use Leanpub to publish their books in-progress, while they are writing them. All readers get free updates, regardless of when they bought the book or how much they paid (including free).
Most Leanpub books are available in PDF (for computers) and EPUB (for phones, tablets and Kindle). The formats that a book includes are shown at the top right corner of this page.
Finally, Leanpub books don't have any DRM copy-protection nonsense, so you can easily read them on any supported device.
Learn more about Leanpub's ebook formats and where to read them
Top Books
- #1
Ansible for DevOps
Jeff GeerlingAnsible is a simple, but powerful, server and configuration management tool. Learn to use Ansible effectively, whether you manage one server—or thousands.
- #2
Functional Programming Made Easier
Charles ScalfaniA Functional Programming book from beginner to advanced without skipping a single step along the way.
In my 40 years of programming, I've felt that programming books always let me down, especially Functional Programming books. So, I wrote the book I wish I had 5 years ago.
Functional Programming will never be easy, but it can be easier.
- #3
Windows 11 Field Guide
Rafael Rivera and Paul ThurrottThe Windows 11 Field Guide is a full-length e-book about the latest version of Microsoft Windows, aimed at those users who will upgrade from Windows 10 or acquire Windows 11 with a new PC.
- #4
C++20 - The Complete Guide
Nicolai M. JosuttisAll new language and library features of C++20 (for those who know previous C++ versions).
The book presents all new language and library features of C++20. Learn how this impacts day-to-day programming, to benefit in practice, to combine new features, and to avoid all new traps.
Buy early, pay less, free updates.
Other books:
- #5
Jetpack Compose internals
Jorge CastilloJetpack Compose is the future of Android UI. Master how it works internally and become a more efficient developer with it. You'll also find it valuable if you are not an Android dev. This book provides all the details to understand how the Compose compiler & runtime work, and how to create a client library using them.
- #6
The Art of Functional Programming
Minh Quang Tran, PhDA master class on the fundamentals and principles of functional programming. It contains 20 programming challenges with detailed solutions and 44 quizzes with answers and explanations. Moreover, 84 diagrams graphically illustrate how concepts and techniques work. Two real-world use cases show how to apply functional programming in practice.
- #7
Production Haskell
Matt ParsonsAre you excited about Haskell, but don't know where to begin? Are you thrilled by the technical advantages, but worried about the unknown pitfalls? This book has you covered.
- #8
Getting to Know IntelliJ IDEA
Trisha Gee and Helen ScottIf we treat our IDE as a text editor, we are doing ourselves a disservice. Using a combination of tutorials and a questions-and-answers approach, Getting to Know IntelliJ IDEA will help you find ways to use IntelliJ IDEA that enable you to work comfortably and productively as a professional developer.
- #9
Effective Kotlin
Marcin MoskałaEffective Kotlin summarizes the best practices and experiences of the Kotlin community, together with a deep explanation of some lesser-known Kotlin functionalities. All of the best practices are presented as simple rules with detailed explanations.
- #10
node-opcua by example
Etienne RossignonGet the best out of node-opcua through a set of documented examples by the author himself that will allow you to create stunning OPCUA Servers or Clients.
Top Bundles
- #3
CCIE Service Provider Ultimate Study Bundle
2 Books
Piotr Jablonski, Lukasz Bromirski, and Nick Russo have joined forces to deliver the only CCIE Service Provider training resource you'll ever need. This bundle contains a detailed and challenging collection of workbook labs, plus an extensively detailed technical reference guide. All of us have earned the CCIE Service Provider certification... - #4
Pattern-Oriented Memory Forensics and Malware Detection
2 Books
This training bundle for security engineers and researchers, malware and memory forensics analysts includes two accelerated training courses for Windows memory dump analysis using WinDbg. It is also useful for technical support and escalation engineers who analyze memory dumps from complex software environments and need to check for possible... - #5
1500 QUIZ COMMENTATI (3 libri)
3 Books
Tre libri dei QUIZ MMG Commentati al prezzo di DUE! I QUIZ dei concorsi ufficiali di Medicina Generale relativi agli anni: 2000-2001-2003-2012-2013-2014-2015-2016-2017-2018-2019-2020-2021 +100 inediti Raccolti in unico bundle per aiutarvi nello studio e nella preparazione al concorso. All'interno di ogni libro i quiz sono stati suddivisi per... - #6
Growing Agile: The Complete Coach's Guide
7 Books
Growing Agile: Coach's Guide Series This bundle provides a collection of training and workshop plans for a variety of agile topics. The series is aimed at agile coaches, trainers and ScrumMasters who often find themselves needing to help teams understand agile concepts. Each book in the series provides the plans, slides, handouts and activity... - #7
Software Architecture
2 Books
"Software Architecture for Developers" is a practical and pragmatic guide to modern, lightweight software architecture, specifically aimed at developers. You'll learn:The essence of software architecture.Why the software architecture role should include coding, coaching and collaboration.The things that you really need to think about before...
