This presentation explains how APIs must be developed as a product, and how you can prepare to capitalize on your API by thinking about: 1) your business purpose, 2) cost/benefit analysis for your intended users, 3) delivery schedule, and 4) supporting and managing your API.

1. Copyright © 2001-2013 SOA Software, Inc. All Rights Reserved.
APIs
A Soup to Nuts Analysis

2. Copyright © 2001-2013 SOA Software, Inc. All Rights Reserved.
Soup to Nuts
• API Lifecycle
• API (Management) Reference Architecture

3. Copyright © 2001-2013 SOA Software, Inc. All Rights Reserved.
The API Lifecycle
Plan
Build
RunShare
Analyze

4. Copyright © 2001-2013 SOA Software, Inc. All Rights Reserved.
Plan
Plan
Build
RunShare
Analyze
Your API must be a product.
You need to:
1. Determine the business purpose
for the API.
2. Understand the cost/benefit
outcomes for the business and
intended users.
3. Agree on the priority and delivery
schedule for the API.
4. Structure your business to
support and manage the API.

5. Copyright © 2001-2013 SOA Software, Inc. All Rights Reserved.
Build
Build from the outside in. You
need to:
1. Understand and clearly articulate
the detailed requirements for the
API.
2. Make sure there is agreement
between key players before
development starts.
3. Separate functional from non-
functional requirements and develop
only to the functional requirements.
4. Iterate through the API
development process.
5. Utilize existing investments
Plan
Build
RunShare
Analyze

6. Copyright © 2001-2013 SOA Software, Inc. All Rights Reserved.
Run
Plan
Build
RunShare
Analyze
Protect, Secure, Manage. You
need to:
1. Support non-functional
requirements in an API Platform,
rather than each API
2. Manage provisioning & access
control for your Apps
(monetization and control)
3. Provide API monitoring

7. Copyright © 2001-2013 SOA Software, Inc. All Rights Reserved.
Share
Plan
Build
RunShare
Analyze
Publish, Support, Syndicate.
You need to:
1. Create a marketplace - Internal,
B2B, B2E or B2D
2. Interact with and recognize your
API Developers
3. Create great documentation about
your API and how to use it
4. Make testing against your API as
easy as possible
5. Monetize your API to assist in
future cost benefit analysis

8. Copyright © 2001-2013 SOA Software, Inc. All Rights Reserved.
Analyze
Plan
Build
RunShare
Analyze
Measure, Report, Iterate. You
need to:
1. Measure and report on the
success of your program across
the whole lifecycle
2. Provide reporting for monetization
3. Drive improvement back into the
planning stage

9. Copyright © 2001-2013 SOA Software, Inc. All Rights Reserved.
Reference Architecture

10. Copyright © 2001-2013 SOA Software, Inc. All Rights Reserved.
Reference Architecture
Plan Build Run Share Analyze

11. Copyright © 2001-2013 SOA Software, Inc. All Rights Reserved.
Lifecycle Management
• Think of this as the ERP system for
your API factory
• Organizations have 2 options:
– Ungoverned - directly defined in the
Gateway and Developer Portal
– Governed - a controlled, managed
process for publication. A factory.
• Based on API proliferation and use
case e.g. B2B.

12. Copyright © 2001-2013 SOA Software, Inc. All Rights Reserved.
Lifecycle Management
• Approvals and workflow
• Costing
• Work stream alignment
– Business
– Product Management
– Documentation
– Legal
– Development
• API Modeling
• Best practices and templates
• Versioning and Change
Management
• Impact Analysis

13. Copyright © 2001-2013 SOA Software, Inc. All Rights Reserved.
Gateway
• Two models exist:
• Proxy
– Simple proxy
• Gateway
– Can proxy, but supports reusable,
scalable API development as well
– Gateway-specific capabilities
– Appliance footprint

14. Copyright © 2001-2013 SOA Software, Inc. All Rights Reserved.
Gateway
• Process
Composition/Orchestration
– Improved time to market
• Security
– Enable new channels
• Attack Prevention
– Protect your systems from abuse
• Caching and Paging
– Support mobile devices
• QoS Management
– Protect relationships

15. Copyright © 2001-2013 SOA Software, Inc. All Rights Reserved.
Developer Portal
• Three models exist today:
• Build your own from scratch
– Time consuming
– Lack of integration with
gateway
• Brand a vendor product
– Fastest time to market
– Well integrated
– Less flexible
• Embed and Integrate
– Balanced

16. Copyright © 2001-2013 SOA Software, Inc. All Rights Reserved.
Developer Portal
• Self-service community
– Promote innovation
– Lower support costs
• Interactive Docs
– Increase adoption
• App Provisioning
– Gain visibility and control
• Integrated Testing
– Speed up learning
• Analytics
– Provide feedback
– Measure success

17. Copyright © 2001-2013 SOA Software, Inc. All Rights Reserved.
Our Products
Plan Build Run Share Analyze

18. Copyright © 2001-2013 SOA Software, Inc. All Rights Reserved.
Lifecycle Manager
• Industry-leading SDLC
governance platform
• Deep integration with IDEs, SCMs
and other development tools
• Workflow & Approvals
• Top-down API modeling
• Documentation, Legal & API
• Policy Inheritance
• Change Management, Impact
Analysis

19. Copyright © 2001-2013 SOA Software, Inc. All Rights Reserved.
Gateway
• Scalable, high-performance
• Policy driven & centrally managed
• Orchestration, Scripting
• Comprehensive security – OAuth,
SAML STS, WS-S
• Quality of Service
• Protection – DoS, AV, Injection,
etc.

20. Copyright © 2001-2013 SOA Software, Inc. All Rights Reserved.
Community Manager
• A customizable developer portal
• Flexible - from turnkey to complete
custom using our API
• Integrated API documentation
• App provisioning and monitoring
• Integrated Testing via DevConsole
• License Management
• Partner/Group Management
• Analytics
• Integrated forums, trouble ticket
management
• Federation to enable new business
models

21. Copyright © 2001-2013 SOA Software, Inc. All Rights Reserved.
Flexible Deployment Model

22. Copyright © 2001-2013 SOA Software, Inc. All Rights Reserved.
Thanks…
• Alistair Farquharson, CTO, SOA Software
• @SOASoftwareInc
• http://www.soa.com