rest apis for partners. what's the catch when applying best practices?

Post on 28-Nov-2014

128 Views

Category:

Software

0 Downloads

Preview:

Click to see full reader

DESCRIPTION

Talk a Nordic API Platform Summit 2014. See the video on https://www.youtube.com/watch?v=qjTUpLMN2DU&index=6&list=PLd2MPdlXKO1145w18Zdt1YqF4_qNYoBDP

TRANSCRIPT

REST APIs for partnersApplying best practices

Helping clients enable e-commerce

Warehouse

Payments

Delivery

Clients

ERP

Shop frontend

REST API

Warehouse

Payments

Delivery

ERP

Shop frontend

Clients x5

Private API

Small amount of integrations

Huge impact

No public support

No excitement

API is evil

Ph

oto

Cre

dit

: sc

rag

zh

ttp

s://

ww

w.fli

ckr.

com

/ph

oto

s/2

72

61

72

0@

N0

0/1

32

75

07

28

/

Make it smooth

Ph

oto

Cre

dit

: Ela

deM

anu

htt

ps:

//w

ww

.fli

ckr.

com

/ph

oto

s/2

41

41

54

6@

N0

6/9

12

42

53

70

7

Fix processes

Integration is all over the place

Integrate orders List goods

Integrate goods

Integrate orders

List goods

Integrate goods

time

time

Set up correct processes

Have a ready project for them

Data gathering

Business processes

API endpoints

Errors and handling

Communication plan

Acceptance process

Use cases, not tools

Ph

oto

Cre

dit

: sg

race

htt

ps:

//w

ww

.fli

ckr.

com

/ph

oto

s/7

60

45

48

@N

07

/46

74

44

43

8/

Tools focused

Use-case focused

This is an API for …

Adding order

To add an order first make sure you have SKUs uploaded then show user a delivery prompt. Thenadd the order with selected goods and a delivery method.

Showing a delivery prompt

To show delivery prompt…

Ph

oto

Cre

dit

: A

lmaz

UK

htt

ps:

//w

ww

.fli

ckr.

com

/ph

oto

s/8

86

90

29

@N

03

/35

64

24

43

82

/

Log their input and errors

URLs

Request bodies

Errors

Have an integration table

Client 1 Client 2 Client 3

Orders create + + +

Orders read - - +

Goods create + + -

Goods read - - -

Break compatibility

Ph

oto

Cre

dit

: Je

sus

Sola

na

htt

ps:

//w

ww

.fli

ckr.

com

/ph

oto

s/6

50

69

06

7@

N0

0/6

40

69

83

89

1/

Sale it then build it

Ph

oto

Cre

dit

: Je

sus

Sola

na

htt

ps:

//w

ww

.fli

ckr.

com

/ph

oto

s/6

50

69

06

7@

N0

0/6

40

69

83

89

1/

Do their work

Have integration plan

Have testing plan

Log religiously

Watch their usage

Avoid building till needed

Negotiate change

REST API for partners

Konstantin Yakushev http://twitter.com/kojoru kojo@kojo.ru

top related