apis: a soup to nuts analysis

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

Drag picture to placeholder or click icon to addAPIs

A Soup to Nuts Analysis


Soup to Nuts

• API Lifecycle• API (Management) Reference Architecture


The API Lifecycle

Plan

Build

RunShare

Analyze


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.


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


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


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


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 monetization3. Drive improvement back into the

planning stage


Reference Architecture


Reference Architecture

Plan Build Run Share Analyze


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.


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


Gateway

• Two models exist:• Proxy

– Simple proxy• Gateway

– Can proxy, but supports reusable, scalable API development as well

– Gateway-specific capabilities– Appliance footprint


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


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


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


Our Products

Plan Build Run Share Analyze


Drag picture to placeholder or click icon to add

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


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.


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


Flexible Deployment Model


Thanks…

• Alistair Farquharson, CTO, SOA Software• @SOASoftwareInc• http://www.soa.com

http://www.soa.com/

apis: a soup to nuts analysis

Technology

developer

2013 soa software

lifecycle

functional

reference

rights reserved

api

business