CAM API Compass: Get Your Bearings on Your API Journey

API Days Paris 2018 [https://www.apidays.co/paris]

Erik Wilde
API Academy, CA Technologies

December 11, 2018

Creative Commons License [http://creativecommons.org/licenses/by/3.0/]

This work is licensed under a CC
Attribution 3.0 Unported License
[http://creativecommons.org/licenses/by/3.0/]

Contents Erik Wilde : CAM API Compass: Get Your Bearings on Your API Journey

Contents

Erik Wilde : CAM API Compass: Get Your Bearings on Your API Journey

(2) Summary

Getting started and maintaining momentum with an API strategy can be a challenging task, with many moving and constantly evolving parts along the way. Continuous API Management (CAM) provides a structured look at the maturity on individual APIs, as well as on the overall API landscape and how it evolves over time. The CAM API Compass uses the concepts of product pillars and landscape aspects to provide a structured assessment of the status of individual APIs and the overall landscape. The CAM API Compass can help API developers and API architects to gain a better understanding of their API maturity, and where to best invest to improve their strategy and execution.



Introduction

Outline (Introduction)

  1. Introduction [4]
  2. The API Journey [5]
  3. API Archaeology [2]
  4. API Landscape Compass [12]
  5. API Product Compass [5]
  6. Conclusions [2]
Introduction Erik Wilde : CAM API Compass: Get Your Bearings on Your API Journey

(4) @dret on Twitter/GitHub

dret

Introduction Erik Wilde : CAM API Compass: Get Your Bearings on Your API Journey

(5) API Academy [http://www.apiacademy.co/]

API Academy

Introduction Erik Wilde : CAM API Compass: Get Your Bearings on Your API Journey

(6) Continuous API Management

Continuous API Management: Making the Right Decisions in an Evolving Landscape

Introduction Erik Wilde : CAM API Compass: Get Your Bearings on Your API Journey

(7) About Me



The API Journey

Outline (The API Journey)

  1. Introduction [4]
  2. The API Journey [5]
  3. API Archaeology [2]
  4. API Landscape Compass [12]
  5. API Product Compass [5]
  6. Conclusions [2]
The API Journey Erik Wilde : CAM API Compass: Get Your Bearings on Your API Journey

(9) Digital Transformation Vision

Trust the Eagle!

Our Digital Transformation Initiative puts a focus on innovation by allowing is to more quickly develop and execute on new ideas. Innovation is the driving force that allows us to improve engagement with existing customers, and to explore new markets.

The Digital Transformation Initiative will turn us into the leader of the industry by allowing us to interact with our customers more easily, and more frequently. By increasing the number of customer touchpoints and using the resulting feedback to quickly and relentlessly adapt and improve our offerings, we will be able to outperform our competition and turn into the market leader within the next three years.



The API Journey Erik Wilde : CAM API Compass: Get Your Bearings on Your API Journey

(10) The Execution Gap

Grand Canyon

The API Journey Erik Wilde : CAM API Compass: Get Your Bearings on Your API Journey

(11) Transformation 1-2-3

  1. Set a vision as the goal to improve the organization
  2. Define a strategy that details the vision into concrete goals
  3. Have a program how to achieve the goals defined in the strategy


The API Journey Erik Wilde : CAM API Compass: Get Your Bearings on Your API Journey

(12) Brownfield Transformation

  1. Understand the existing landscape of proto-APIs and their genesis
  2. Understand the existing culture of teams for their integration tasks
  3. Your initial API Strategy is the sum of all these parts
  4. Drive change through communications and support (make API development easier)


The API Journey Erik Wilde : CAM API Compass: Get Your Bearings on Your API Journey

(13) Guidelines: Why? What? How? Test!



API Archaeology

Outline (API Archaeology)

  1. Introduction [4]
  2. The API Journey [5]
  3. API Archaeology [2]
  4. API Landscape Compass [12]
  5. API Product Compass [5]
  6. Conclusions [2]
API Archaeology Erik Wilde : CAM API Compass: Get Your Bearings on Your API Journey

(15) Understanding the Past

Archaeology is the practice of unearthing artifacts, and understanding them in the context of their origins in time and location. That exact concept can be applied to APIs as well. API Archaeology thus is the practice of finding integrations, understanding why and how they were created, and documenting them as a way to better understand the history and structure of complex IT landscapes. Practicing 'API Archaeology' in organizations can be extremely valuable in terms of finding out about existing ways in which IT components interact (in some shape or form).

[Continuous API Management: Making the Right Decisions in an Evolving Landscape [http://www.oreilly.com/catalog/0636920201755]]



API Archaeology Erik Wilde : CAM API Compass: Get Your Bearings on Your API Journey

(16) Sharing and Scaling



API Landscape Compass

Outline (API Landscape Compass)

  1. Introduction [4]
  2. The API Journey [5]
  3. API Archaeology [2]
  4. API Landscape Compass [12]
  5. API Product Compass [5]
  6. Conclusions [2]
API Landscape Compass Erik Wilde : CAM API Compass: Get Your Bearings on Your API Journey

(18) Learning from Legacy Landscapes



API Landscape Compass Erik Wilde : CAM API Compass: Get Your Bearings on Your API Journey

(19) API Landscape Aspects

cam-compass-landscape.png

API Landscape Compass Erik Wilde : CAM API Compass: Get Your Bearings on Your API Journey

(20) V1: Variety

Example Question: How easy is it for your landscape to embrace and support a new API technology?


API Landscape Compass Erik Wilde : CAM API Compass: Get Your Bearings on Your API Journey

(21) V2: Vocabulary

Example Question: Is there an easy way for developers to discover the vocabularies that are in use throughout existing APIs?


API Landscape Compass Erik Wilde : CAM API Compass: Get Your Bearings on Your API Journey

(22) V3: Volume

Example Question: How easy is it for developers to design, implement, and deploy a new product?


API Landscape Compass Erik Wilde : CAM API Compass: Get Your Bearings on Your API Journey

(23) V4: Velocity

Example Question: Does anything in the API landscape slow down teams when creating or changing APIs?


API Landscape Compass Erik Wilde : CAM API Compass: Get Your Bearings on Your API Journey

(24) V5: Vulnerability

Example Question: Are APIs designed from the ground up to be potentially externalizable?


API Landscape Compass Erik Wilde : CAM API Compass: Get Your Bearings on Your API Journey

(25) V6: Visibility

Example Question: How easy it is for architects, teams, and consumers to explore the entire API landscape?


API Landscape Compass Erik Wilde : CAM API Compass: Get Your Bearings on Your API Journey

(26) V7: Versioning

Example Question: Are APIs designed and implemented so that changes create as little disruption as possible?


API Landscape Compass Erik Wilde : CAM API Compass: Get Your Bearings on Your API Journey

(27) V8: Volatility

Example Question: Are all dependencies implemented to be visible and to behave responsibly when some APIs fail?


API Landscape Compass Erik Wilde : CAM API Compass: Get Your Bearings on Your API Journey

(28) API Archaeology Compass

compass-archaeology.png

API Landscape Compass Erik Wilde : CAM API Compass: Get Your Bearings on Your API Journey

(29) Guideline Convergence



API Product Compass

Outline (API Product Compass)

  1. Introduction [4]
  2. The API Journey [5]
  3. API Archaeology [2]
  4. API Landscape Compass [12]
  5. API Product Compass [5]
  6. Conclusions [2]
API Product Compass Erik Wilde : CAM API Compass: Get Your Bearings on Your API Journey

(31) Product Pillars and Maturity



API Product Compass Erik Wilde : CAM API Compass: Get Your Bearings on Your API Journey

(32) API Product Pillars

cam-compass-product.png

API Product Compass Erik Wilde : CAM API Compass: Get Your Bearings on Your API Journey

(33) API Product Maturity Compass

compass-maturity.png

API Product Compass Erik Wilde : CAM API Compass: Get Your Bearings on Your API Journey

(34) Assessing API Products: Change Management

  • Does your design include a plan how to make any changes to the API?
  • Do you have an idea of what your API should and shouldn't be, so that you can more easily decide which evolution paths you are trying to keep open?
  • If your design does not plan on evolving the API itself, do you have a plan how to operate multiple versions and how to manage the consumers of these multiple versions?
  • If your design includes a plan for evolving the API itself, do you document this clearly so that clients know what to expect?
  • Does your documentation include a history of changes so that it is possible for consumers to understand how the API evolved?
  • Do you have a plan how to decommission the API, and how this will be communicated to active consumers?


API Product Compass Erik Wilde : CAM API Compass: Get Your Bearings on Your API Journey

(35) API Product Compass

compass-api.png

Conclusions

Outline (Conclusions)

  1. Introduction [4]
  2. The API Journey [5]
  3. API Archaeology [2]
  4. API Landscape Compass [12]
  5. API Product Compass [5]
  6. Conclusions [2]
Conclusions Erik Wilde : CAM API Compass: Get Your Bearings on Your API Journey

(37) Guiding the API Journey



Conclusions Erik Wilde : CAM API Compass: Get Your Bearings on Your API Journey

(38) Thanks! Q&A

What's Next?

December 11, 2018 API Days Paris 2018 [https://www.apidays.co/paris]