Best Practices for API Adoption
0 likes684 views
The document outlines best practices for API adoption, highlighting the importance of understanding developer needs and targeting the right audience. It emphasizes effective onboarding to minimize barriers for developers and the necessity of good documentation and support to ensure successful API integration. Ultimately, it encourages organizations to evolve their strategies to create a thriving developer ecosystem that drives innovation and loyalty.
Best Practices for API Adoption
- 1. © Copyright 2013 AnyPresence, Inc. All rights reserved. Best Practices for API Adoption Carlo Longino VP of Developer Program Services, WIP Factory 1 Richard Mendis Chief Product and Marketing Officer, AnyPresence
- 2. Internet of Things (All Smart Devices, Cars, Appliances, Wearables, etc.) #ofDevices Evolving Connected Technology Landscape 2 Time PCs Post-PC (Smartphones, Tablets, TVs, etc.) Images: Brad Frost The most successful organizations will be those who enable strong developer ecosystems
- 3. © Wireless Industry Partnership Connector Inc. Increased revenue Lower costs Faster 1me to market New users Wider content spread Increased traffic Lead genera1on Increased loyalty S1ckiness/lock-‐in INNOVATION What do we want from our APIs?
- 4. © Wireless Industry Partnership Connector Inc. What we are really asking is: What do we want developers to do with our APIs?
- 5. © Wireless Industry Partnership Connector Inc. Millions of developers From Flickr user jamescridland Thousands of APIs What is the landscape like?
- 6. © Wireless Industry Partnership Connector Inc. § IDC: 18.5 million So?ware Developers § EDC: 18.2 million Developers § Plumbr: 43 million So?ware developers § hGps://plumbr.eu/blog/how-‐many-‐java-‐developers-‐in-‐the-‐world § Stackoverflow: 26.9 million monthly Visitors § WIP: Over 50% of developers visit SO every week → Developers=>50 million Great Math! How many developers?
- 7. © Wireless Industry Partnership Connector Inc. This week: 12,239
- 8. © Wireless Industry Partnership Connector Inc. What this means for your API program: You need to focus on the right developers. You need to get them to invest their currency – time – in your APIs.
- 9. © Wireless Industry Partnership Connector Inc. TargeWng “All Developers” is not an effective Strategy Targeting “All Developers”
- 10. © Wireless Industry Partnership Connector Inc. http://onebigphoto.com/a-long-tail-of-stingray/ We’re targeWng the “Long Tail” That’s not an effec1ve strategy either as s1ll too broad. Targeting the “Long Tail”
- 11. © Wireless Industry Partnership Connector Inc. Individuals Internal Coders Students Big companies Independents Developers/designers /backend experts/ Truths: § There are lots of different types of developers out there. Who is most important to you? § Different groups have different needs and desires, and need different messages. Companies External Users Suits Pros Small companies Brands DB analysis Android/IOS Targeting factors
- 12. © Wireless Industry Partnership Connector Inc. You don’t have unlimited resources. Filter & Group based on relevant characterisWcs. Each needs different services, support, markeWng messages and acWviWes. Developers aren’t all the same
- 13. © Wireless Industry Partnership Connector Inc. They aren’t all creaWve & they can’t read minds. So help them paint the picture. Manage YOUR expecta1ons. http://upload.wikimedia.org/wikipedia/commons/e/ef/Modern-Trade-Painter.jpg The myth of developers
- 14. © Wireless Industry Partnership Connector Inc. Once you have the right group, Get them off to the races! Get the right group!
- 15. © Wireless Industry Partnership Connector Inc. § The process of ge`ng a developer to use your product or service § Post-‐awareness, exploraWon, ge`ng started, learning, going live, using your stuff What is onboarding?
- 16. © Wireless Industry Partnership Connector Inc. § It’s crucial to minimize the hurdles/obstacles/ fricWon between ge`ng started and going live § This is where you will lose the most developers from your program § It’s also something you have a lot of control over! Why is it so important?
- 17. © Wireless Industry Partnership Connector Inc. 1 First Impression 2 Product Messaging Make it easy for the right developer to get your message and take action. Answer “What’s in it for me?” 3 Examples and Case Studies Show who uses your technology, what they do and how they benefit. 4 Registration Keep the requirements light and the process quick. 5 Getting Started Get developers up and running quickly. Minimize your TTFHW! 6 Docs and Support Good documentation is essential – and it’s part of the decision-making process. 7 Libraries and SDKs Light the path by creating add-ons and tools that are right for your developers. 7-Point API Onboarding Review www.wipfactory.com © Wireless Industry Partnership Connector Inc.
- 18. © Wireless Industry Partnership Connector Inc. § Understand WHO they are, and the Wming and context around their needs. § Who is this for? § What does it do? § What’s in it for me? 1 Make it easy for the right developer to get your message and take action. First Impression First Impression
- 19. © Wireless Industry Partnership Connector Inc. 2 Product Messaging Answer “What’s in it for me?” Expand on the Value ProposiWon Why would I use this product? Why is it beGer than other soluWons? Why does it deserve my Wme? Where’s my win? Product Messaging
- 20. © Wireless Industry Partnership Connector Inc. 3 Examples and Case Studies Show who uses your technology, what they do and how they benefit. § Show developers how it’s working, rather than telling them. § Builds understanding and credibility § Focus on speaking to the right context § Show the benefits Examples and Case Studies
- 21. © Wireless Industry Partnership Connector Inc. 4 Registration Keep the requirements light and the process quick. § Your best chance to screw things up! § Ask for as liGle info as necessary § Being able to use the tool/API/SDK/ code is part of the learning and decision-‐making process Registration Registration
- 22. © Wireless Industry Partnership Connector Inc. 5 Getting Started Get developers up and running quickly. Minimize your TTFHW! § What is your Time To First Hello World? § How quickly can developers see results? § Do you have a bulletproof Quick Start Guide? “You'd use these to hand-‐write your computer programs. In pencil.” “The next day you could find out if your code compiled or not.” hp://simonallardice.com/general/2014/03/17/first-‐computer.html Getting Started
- 23. © Wireless Industry Partnership Connector Inc. 6 Docs and Support Good documentation is essential – and it’s part of the decision-making process. § Get the content correct & and make it easy to use § No PDFs, DOCs, use HTML § Make your search work § Don’t hide behind logins § Don’t forget code samples, and demos § Forums – meh… -‐ go where developers go Documentation and Support
- 24. © Wireless Industry Partnership Connector Inc. 7 Libraries and SDKs Light the path by creating add-ons and tools that are right for your developers. § Create the right ones for your users § Link to outside libraries and open-‐source projects § Creates currency with community, as well as supports developers Libraries and SDKs
- 25. © Wireless Industry Partnership Connector Inc. To Sum Up: 1. Find the right developers. 2. Understand what they want and need. 3. Light the way for them, and help them down the path. 4. Manage your expectations.
- 26. © Wireless Industry Partnership Connector Inc. A?er you’ve goGen the rest of it right, maybe! Ah, so where do hackathons fit in?... Hackathon?
- 28. Forecast: “Resurgence” of Native Apps, More Fragmentation 28 RelativeComputingPower Amount of Devices “Long-tail” IoT devices with embedded computing capabilities Mainstream personal and business computing devices Browser-supported apps possible Primarily native app driven
- 29. Development Expectation Challenges 29 Development cycles down to 6-8 months or less, from 12-18 Development budgets not increasing to match mobile needs Complexity across Front-end, back- end and secure, scalable integration Development, Design, Develop, Test all work on the same cadence: Rapid Prototyping and Ongoing Updates LESS TIME LESS BUDGET MORE COMPLEX Source: Forrester Research MORE DYNAMIC
- 30. API Mobile Adoption Challenges and Opportunity Documentation Method § Documentation on API methods Challenge § Limited ability to understand context of methods § Docs can get out of date Result ✘ Poor adoption ✘ Takes longer to build apps 30 Live Apps, Dynamic Sample Code § Live, interactive sample app § Fully working app with source code and SDK § Maintaining code base across multiple platforms § Providing server-side deployment options for complex scenarios ✔ Significantly improve developer adoption ✔ Faster time to market with customized sample app and portable source code Mobile Adoption Static Sample App Code § Provide a link to some example app in one platform § More difficult to maintain (requires multiple skillsets) § Not customized to a specific use case § Limited data sets ✘ Expensive to build and maintain ✘ Addresses limited use cases Static Sample Code Snippets § Snippets of code in a few languages § API Explorer § Difficult to maintain § Not customized to a specific use case ✘ Doesn’t provide a fully working example ✘ Takes longer to build apps Incremental Improvement Opportunity: Exponential Improvement
- 31. Beyond APIs: Improving Ecosystem Adoption 31 APIs Endpoints Only § Takes time to interpret and implement § Lacks app-specific mobile services; typically optimized for web apps Mobile Backend Server ü Mobile optimized APIs, domain-specific abstraction layer ü App-specific services and business logic Cross-platform SDKs (+docs) ü Drop into app project ü Familiar syntax App UI Starter Kits ü Fully-working app ü Editable source code Lower development hurdles, reduce time to market, and improve adoption APP DEVELOPMENT TIMEFRAME
- 32. Brief Demo: Enhancing Your Developer Portal 32
- 33. 1 How It Works § Define templates with pre-built integration to your product, service, or content § Determine which features can be customized by partner or customer developers 3 PARNTERSCUSTOMERS § Download source code for backend server, SDKs, and UI starter kits (option to compile apps and host server) § Functional app with customizable code and deployment options Enable Developer Ecosystem Define App Templates Your Company’s Developer Portal § Custom-branded developer portal or new functionality within existing solution § Enables users to select a template, specify options, and generate an cross-platform apps 2 Build Developer Portal
- 34. Use Cases and Key Benefits Internal Use For use within the organization to build and deploy apps faster Key Benefits: ü Efficiency / Scale ü Enforce IT Policy 34 Partner Use For use by approved partners to enable specific functions within their apps Key Benefits: ü Partner Enablement ü Retain Control External Use For use by external developers, to encourage adoption of public APIs Key Benefits: ü Adoption ü Revenue / Brand Recognition
- 35. User Interface “Starter Kit” ü Cross-platform UI code with SDK examples ü non-proprietary, editable source code ü Template starter kits Lessons Learned: Evolving Developer Ecosystem Needs 35 API Management ü REST-enable HTTP endpoints ü Usage and bandwidth throttling ü Key management ü Business Logic ü Developer Portal Backend Services ü Object Relational Mapping layer for “composite” apps ü Cross-platform SDKs ü Mobile-specific business logic ü Mobile services (push, SMS, etc.) …with an architecture that accommodates the evolving needs of new devices and endpoints You need to meet the needs of mobile- enabling a developer ecosystem today… Happy Developer Ecosystem
- 36. Keep in touch! Contact AnyPresence 25