apidays LIVE Jakarta 2021 - Accelerating Digitisation February 24, 2021 5 ways to make your integration more resilient Jenks Guo, Developer Evangelist at Xero

1. 5 Ways to Make
Your Integration
More Resilient
Jenks Gu
o
DEVELOPER EVANGELIST, XERO

4. Jenks Guo
• Software Develope
r
• Developer Evangelist @ Xer
o
• Reviewed many integration
s
• Write technical conten
t
• Build SDK tools

5. #XD19
Xero app ecosystem

6. Resilience
• what is resilience?
• 5 ways to achieve
resilienc
e
• how to prevent and
deal with failures?
PHOTO BY ZACH REINER ON UNSPLASH

7. Resilience
The capacity to
recover quickly from
dif
fi
culties; toughness
PHOTO BY ROMAIN VIGNES ON UNSPLASH

8. Resilienc
e
API INTEGRATION
• Understands
constraint
s
• Improves ef
fi
cienc
y
• Handles errors
• Care for users

9. The ability of an app
to recover from
certain types of
failure and remain
functional from the
customer perspective
PHOTO BY ROMAIN VIGNES ON UNSPLASH
Resilienc
e
API INTEGRATION

10. ∞

11. API Limits
Everywhere

12. API calls per month
850m
Users of Xero
API
75k+
Registered apps
30k+
Subscribers
2m+
1st cloud
accounting API
2007
Webhook batches
2.3m
API endpoints available
and growing
40+
Certi
fi
ed app
partners
800+
Delivering
an API
Program
at Scale

14. 5 ways to
improve API
ef
fi
ciency
If-modified-since
Filter
Batching Paging Webhooks

15. developer.xero.com/documentation/api/invoices#put
x 500
0
API calls
Batching
create & update
things in batches

16. Paging GET https://api.xero.com/api.xro/
2.0/Invoices
Get all invoices in summary
"LineItems": [],
Get one invoice in great details
"LineItems":
[
{
"Description": "Company car park (month in advance)"
,
"UnitAmount": 135
,
"TaxType": "INPUT"
,
"TaxAmount": 13.5
,
"LineAmount": 135
,
"AccountCode": "449"
,
"Tracking": []
,
"Quantity": 1
,
"LineItemID": "c997b810-
b637-439d-9036-93fd4319011f"
,
"ValidationErrors": [
]
}],
GET https://api.xero.com/api.xro/2.0/Invoices/
243216c5-369e-4056-ac67-05388f86dc81
getting
information in
batches

17. Paging
Get the 1st 100 invoices with details:
"LineItems":
[
{
"Description": "Company car park (month in advance)"
,
"UnitAmount": 135
,
"TaxType": "INPUT"
,
"TaxAmount": 13.5
,
"LineAmount": 135
,
"AccountCode": "449"
,
"Tracking": []
,
"Quantity": 1
,
"LineItemID": "c997b810-b637-439d-9036-93fd4319011f"
,
"ValidationErrors": [
]
}],
GET https://api.xero.com/api.xro/2.0/Invoices?
page=1
x 100
page=1
x 100
page=2
x 100
page=3
x 23
page=n
getting
information in
batches

18. Filters
Retrieve all unpaid Invoices against a particular contact?
read all
invoices
GET https://.../Invoices?page=1&ContactIDs=3138017f-8ddc-420e-a159-
e7e1cf9e643d&Statuses=AUTHORISED
check contacts
& status
read each invoice
for details ?
getting
information in a
smart way

19. If-modi
fi
ed-since
get all invoices process/store invoices
compare al
l
old invoices data
pulling data the
brut force way

20. If-modi
fi
ed-since
invoices modi
fi
ed
since last sync
process/store invoices
pulling data the
smarter wa
y
look out for
“Expires” HTTP
header

21. Invoices
Contacts
Create / Update events
Your App
Webhooks
the reverse of
API calls

22. Webhooks
developer.xero.com/documentation/webhooks/overview
It is only a
noti
fi
cation

23. Webhooks Webhook
An invoice has been paid full
:
Status: Authorised -> Paid
Send GET request for
complete invoice details
API
GET
Store payment info and
invoice status
Send noti
fi
cation to user
Your App

24. When things
go wrong…
PHOTO BY SARAH KILIAN ON UNSPLASH

25. Errors
170 millio
n
4xx & 5xx errors per month

26. “A clever person solves a problem.
A wise person avoids it.”
Albert Einstein

28. The Good,
Error
Handling

29. The Good, The Better,
Error
Handling T

30. e Better,
Error
Handling The Best?

31. Audit
Logs

32. Noti
fi
cations

33. API outage
PHOTO BY OZZIE STERN ON UNSPLASH
• decouple your ap
p
• queue your message
s
• implement a retry
policy

34. De
fi
ne
Recap
How Recover
• Software
integration
resilience
• Respect limit
s
• Improve ef
fi
ciency
• Validation
s
• Error handlin
g
• Outages

35. Thanks
jenks.guo@xero.com
Contact Follow
api@xero.com
github.com/XeroAPI
@xeroapi
Xero Developer
devblog.xero.com
@JenksGuo

36. Q & A

37. xero.com/developer