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
Authors have earned$9,536,567writing, 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
The Leanpub 45-day 100% Happiness Guarantee
Within 45 days of purchase you can get a 100% refund on any Leanpub purchase, in two clicks.
See full terms
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), EPUB (for phones and tablets) and MOBI (for 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
Algebra-Driven Design
Sandy MaguireA how-to field guide on building leak-free abstractions and algebraically designing real-world applications.
- #2
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.
- #3
Machine Learning Engineering
Andriy Burkov"If you intend to use machine learning to solve business problems at scale, I'm delighted you got your hands on this book."
—Cassie Kozyrkov, Chief Decision Scientist at Google
"Foundational work about the reality of building machine learning models in production."
—Karolis Urbonas, Head of Machine Learning and Science at Amazon
- #4
The Hundred-Page Machine Learning Book
Andriy BurkovEverything you really need to know in Machine Learning in a hundred pages.
- #5
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.
- #6
OpenIntro Statistics
David Diez, Christopher Barr, Mine Cetinkaya-Rundel, and OpenIntroA complete foundation for Statistics, also serving as a foundation for Data Science.
Leanpub revenue supports OpenIntro (US-based nonprofit) so we can provide free desk copies to teachers interested in using OpenIntro Statistics in the classroom and expand the project to support free textbooks in other subjects.
More resources: openintro.org.
- #7
Cloud Strategy
Gregor HohpeWhile most enterprises are moving to the cloud these days, many initiatives are driven by wishes or promises rather than a sound strategy. Harvested from half a decade of cloud migrations, this book shares frameworks, strategies, and anecdotes for a structured and decision-centric path to cloud success.
- #8
Sockets and Pipes
Type ClassesSockets and Pipes is not an introduction to Haskell; it is an introduction to writing software in Haskell. Using a handful of everyday Haskell libraries, this book walks through reading the HTTP specification and implementing it to create a web server.
- #9
C++ Best Practices
Jason TurnerLevel up your C++, get the tools working for you, eliminate common problems, and move on to more exciting things!
- #10
Practical FP in Scala: A hands-on approach
Gabriel VolpeA practical book aimed for those familiar with functional programming in Scala who are yet not confident about architecting an application from scratch.
Together, we will develop a purely functional application using the best libraries in the Cats ecosystem, while learning about design patterns and best practices.
Top Bundles
- #1
The Node.js Bundle
3 Books
This bundle combines three bestselling Leanpub Node.js books into a package that gives you everything you need to get started with developing Node.js applications at an unbeatable price. - #2
The Tester's Library
8 Books
The Tester's Library consists of eight five-star books that every software tester should read and re-read. As bound books, this collection would cost over $200. Even as e-books, their price would exceed $80, but in this bundle, their cost is only $49.99. Here are the books, and why they should be in your library: Perfect Software and Other... - #3
agile
11 Books
In this bundle, you will find 10 different agile books. They are about different aspects of being agile. - finding a job - doing coding dojo's - Retrospectives - Personal kanban - a non-typical coaching book and even a book that gives you an insight in the lives of some agile people. - #4
WTFlop 6M + HU - Beta Bundle
6 Books
- #5
Node Patterns
6 Books
- #6
Fifty Quick Ideas
3 Books
Get all three books for the price of two! Fifty Quick Ideas books are full of practical, real-world techniques that you can use to improve teamwork, build better products and build them in a better way. - #7
Growing Agile: Coach's Guide Series
4 Books
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 instructions to run a number of... - #8
Marionette.js A to Z
3 Books
Marionette.js has become a popular Backbone-based javascript library, because it helps you avoid boiler-plate code and focus on what makes your app special. But how do you get started?Whether you want to finally get started with dynamic client-side programming (like one reader did), or are an experienced front-end dev who has inherited a... - #9
Complete Scala Bundle
3 Books
Scala is a general-purpose programming language and it's getting extremely popular these days. Some say that learning Scala could be a challenging task. My experience, however, suggests that this is actually a myth that has very little to do with reality. With the right approach, learning Scala can be easy, fun and rewarding.The first book from... - #10
Build A Better Backbone App
3 Books
The best way to learn new development skills is through experience, but that takes time you don't have.Get the best of both worlds with this bundle: you'll learn how to produce modern web applications by learning from experienced developers like Derick Bailey and David Sulc. BackboneJS is one of the favorite tools on the web today, but it...
