API Management Pattern with a Focus on Collaboration and ...

Chair of Software Engineering for Business Information Systems (sebis) Faculty of InformaticsTechnische Universität Münchenwwwmatthes.in.tum.de

API Management Pattern with a Focus on Collaboration and Knowledge Sharing and their Implications

Gloria Bondel, SEBIS WORKSHOP, 24th June 2021

1

The Strategic Importance of APIs Increases

Ø !"#$%&#'!()*$)+$,-'!+)&./Ø 0(&#%!$)&$(*0(&#%!$.)*#!(1'!()*$)+$&#/)2&%#/$3+2*%!()*'-(!4$)&$0'!'5Ø (**)6'!()*$7'/#0$)*$'%%#//$!)$&#/)2&%#/Ø %).,-('*%#$8(!"$%2&&#*!$&#92-'!()*/

:;</$#*'7-#$=

2!"#$!%&'()*+,&-./&01)12+3+)4&.144+5)&6141,(2

Tech Giants Provide more Successful APIs than other Organizations

APIs generate value, increase productivity and create strategic advantages

However, APIs are not evenly distributed between companies and branches.

How can organizations that are not Tech Giants successfully provide APIs?

Source: !"#$%&'()'*)&'+',#%-./&'0)'*)'123456)'0/"/#.7$8 9:/ ;(<'/=-%>%9/? #$@ /$9/ABA7%/ %9A#9/8> "7#'"7%C#. #$#.>97=%) *-??C$7=#97-$%'-D 9:/ ;*E& FG126&'25H2I)

3!"#$!%&'()*+,&-./&01)12+3+)4&.144+5)&6141,(2

The Goal of the Pattern Language is to Document API Management Practices

>"#$:;<$.'*'9#.#*!$,'!!#&*$-'*92'9#$'(./$!)$/2,,)&!$)&9'*(1'!()*/$!)$(*(!('!#$'*0$.'*'9#$,27-(%?$,'&!*#&?$)&$9&)2, :;<$(*(!('!(6#/@$Ø A'*'9#.#*!$,'!!#&*/$+)%2/(*9$)*$B*)8-#09#$!&'*/+#&$'*0$%)--'7)&'!()*$(*/!#'0$)+$!#%"*(%'-$,'!!#&*/

Ø :$,'!!#&*$-'*92'9#$'00&#//(*9$!"#$*##0/$)+$#/!'7-(/"#0$)&9'*(1'!()*/$'*0$CAD/Ø >'&9#!$'20(#*%#$'&#$:;<$,&)6(0#&$!#'./Ø >"#$,'!!#&*/$'&#$,"&'/#0$!)$.##!$!"#$(*+)&.'!()*$*##0/$)+$72/(*#//$'*0$<>$/!'B#")-0#&/

Goal

ü Explore proven solutions and benchmark current practicesü Create a common taxonomy between API providers and API consumers as well as between IT and

business stakeholders within an organizationü Basis for theorizing on collaboration and knowledge transfer within and outside of an organization

4!"#$!%&'()*+,&-./&01)12+3+)4&.144+5)&6141,(2

API Management is an Organisational Function at the Interface between an Organization and the API Consumer

!"#$!%&'()*+, -./&01)12+3+)4&.144+5)&6141,(2 7

!"#$%&' (%)*+,- +../0#"102&+,-*3"1%4"5

+,-*6%7%/2.%8*,281"/

!"#$%&'*,8270'%8 9&'*:;%8

Software Artifacts

Stakeholders

providesfuntionality

to

documents

shares data (e.g., user data)

consumesmanages

can be

+,-*<2&;=>%8?-@*"&'*)=;0&%;;A

:..%8*B"&"C%>%&1

D"/%;*E*B"8$%10&C

<=;12>%8*D=..281F%C"/

Collaboration

+,-*,8270'%8

The Patterns Address all Parts of the API Management Lifecycle

!"#$!%&'()*+,&-./&01)12+3+)4&.144+5)&6141,(2 $

Test &Secure

Implement & Deloy

Manage & Configure

Plan & Design

Discovery & On-boarding

Integration & Consumption

Monitoring & Monetization

API Provider activities

API Consumer support activities

!"#$%&'()*+,-.*/0,.*&1-2'2.,#

345-.,2.*&1-2.6%.,1'

4*7".-$6"8,/.

96"&.,&+-:,&.;6,

<=32-)*.>-?%/0,&+-$6"@*+,62

<=32-)*.>-1%.,)%'-$6"@*+,62

A%.%-/7,%6%&/,

345-"6/>,2.6%.*"&-7%',6

345-$6"+;/.-+"/;#,&.%.*"&

!""0?""02

<"B.)%6,-=*?6%6*,2

C6;2.,+-*&.,16%.*"&-$%6.&,6-7*2.

D"7,(?%2,+-#%60,.*&1

E,)27,..,6

!;2."#,6-2;//,22-2."6*,2

9*62.(7,@,7-2;$$"6.

<,6@*/,-+,20-2"B.)%6,

<,7B(2,6@*/,

F;7.*(.,&%&.-#%&%1,#,&.

C%*7"6*&1-3452-."-;2,-/%2,2

5+,%-?%/07"1

Selected API Management PatternRole-based marketing

Context:

Especially in established organizations, technical and non-technical stakeholders are involved in buying an API.

Problem:

How can an API portal provider address the information needs of technical and non-technical stakeholders of a potential consumer organization?

Solution:

Role-based marketing denotes the design, maintenance, and clear separation of marketing material and other consumer-facing resources in the developer portal targeted at different user roles.

Rationale:

If the API provider offers strategic functionality, it has much impact on the business and is difficult to replace later. Thus, the business wants to be involved. https://developer.mercedes-benz.com/

7!"#$!%&'()*+,&-./&01)12+3+)4&.144+5)&6141,(2

API management is …

1

2

… platform management

… product management

Most discovery and collaboration between the API provider and consumer happens through the API portal and the API gateway.

This includes documentation, sandboxes, libraries, etc.

APIs are products or at least a channel for a product. Thus, APIs need to address customer needs and follow a product lifecycle. You will have to involve the business, sales and marketing, legal, etc.

!"#$%&' (%)*+,- +../0#"102&+,-*3"1%4"5

+,-*6%7%/2.%8*,281"/

providesfuntionality

to

documents

shares data (e.g., user data)

consumesmanages

can be

Test &Secure

Implement & Deloy

Manage & Configure

Plan & Design

Discovery & On-boarding

Integration & Consumption

Monitoring & Monetization

API Provider activities

API Consumer support activities

8!"#$!%&'()*+,&-./&01)12+3+)4&.144+5)&6141,(2

3

4

… support management

… defect management

API management has to support the API consumer during the buy-decision, technical integration, and following version changes. Support

requests, bug reports, and business inquiries have to be managed.

Issues have to be forwarded to the associated team and tracked. Different teams can be responsible for an API. Stakeholders within the resolution chain might have different goals and priorities. Personal relationships and agreed processes are key.

https://www.freelancermap.de/blog/jira/

9!"#$!%&'()*+,&-./&01)12+3+)4&.144+5)&6141,(2

5

6

… quality management

… communication

API consumers depend on the provided APIs. Therefore they want guarantees. In B2B relations, APIs commonly follow service-level agreements (SLAs) that

specify the level of service provided to the consumer.

API management responsibilities can be distributed between roles, teams, and even organisations and require collaboration of internal and external stakeholders. Most importantly, the API management has to communicate with the API consumers and collaborate with the backend providers. Other involved stakeholders are API governance authorities, marketing, legal, and customer support.

10!"#$!%&'()*+,&-./&01)12+3+)4&.144+5)&6141,(2

Ø A)/!$%)--'7)&'!()*$7#!8##*$!"#$:;<$.'*'9#.#*!$!#'.$'*0$!"#$:;<$%)*/2.#&$"',,#*/$!"&)29"$/)+!8'&#$'&!(+'%!/$%)*!&)--#0$74$!"#$:;<$.'*'9#.#*!$!#'.@$

Ø E)--'7)&'!()*$7#!8##*$!"#$:;<$.'*'9#.#*!$!#'.$'*0$!"#$7'%B#*0$,&)6(0#&$'*0$(*!#&*'-$/!'B#")-0#&/$.)/!-4$+)%2/#/$)*$F2'-(!4?$0#+#%!?$'*0$(*%(0#*!$.'*'9#.#*!$'%&)//$!#'.?$72/(*#//$2*(!?$)&$%).,'*4$7)2*0'&(#/@

Ø :;<$%)*/2.#&/$'&#$*)!$)*-4$!"#$0#6#-),#&/@ >"#4$'&#$)&9'*(1'!()*/@Ø :*$)&9'*(1'!()*$/")2-0$'0',!$,&)%#//#/$'*0$!"#$)&9'*(1'!()*'-$/!&2%!2&#/$!)$/2%%#//+2--4$,&)6(0#$'*$:;<@

Summary

11

If you are interested in the final version of the API Management Pattern Catalog, please contact me at: [email protected]

!"#$!%&'()*+,&-./&01)12+3+)4&.144+5)&6141,(2

Technische Universität MünchenFaculty of InformaticsChair of Software Engineering for Business Information Systems

Boltzmannstraße 385748 Garching bei München

Tel +49.89.289.Fax +49.89.289.17136

wwwmatthes.in.tum.de

Gloria BondelM.Sc.

[email protected]

+49.176.70825900

12