O documento apresenta 10 dicas para o sucesso de uma API, incluindo selecionar a tecnologia adequada (REST e JSON), projetar a API de forma RESTful, implementar versionamento e tratamento de erros, além de garantir segurança, criar um portal para desenvolvedores e promover a confiabilidade e divulgação da API.

1. Kleber
Bacili
kleber.bacili@sensedia.com
@kleberbacili
Design
de
APIs
RESTful
–
Seguras,
Escaláveis
e
Interoperáveis
–

2. www.slideshare.net/kleberbacili/

3. Kleber
Bacili
kleber.bacili@sensedia.com
@kleberbacili
Cerquilho

4. v Design,
Exposição,
Gerenciamento
e
Engajamento
em
APIs
v Headquarter
em
Campinas,
escritórios
em
Sampa,
Rio
e
Philly
v Classificados
como
Visionários
no
Quadrante
Mágico
do
Gartner
(*)
Magic
Quadrant
for
Integrated
SOA
Governance
Technology
Sets,
2009

5. As
APIs
estão
por
toda
parte…

6. Fonte:
ProgrammableWeb
Clube
dos
Bilhões
5+
Bilhões
de
Calls/Dia
1+
Bilhões
de
Calls/Dia

7. Startup
BaKlefield
78%

8. The
Internet
of
Things

9. Open
Banking?

11. ² Eu
ainda
não
tenho
API…..
² Eu
nem
sei
como
fazer
uma
API…..
² E
a
segurança…..

12. 10Dicas
para
a
sua
API
ser
um
sucesso

13. Dica
Zero!

14. Selecione
a
Tecnologia
Adequada
RESTSOAP vs.

15. Selecione
a
Tecnologia
Adequada
JSONXML vs.

16. and the winners are…
REST + JSON

17. 1Proposta
de
Valor

18. “Você
pode
até
passar
batom
num
porco,
mas
ele
conZnuará
sendo
um
porco!”

19. 2Design
RESTful

20. Coleção
/pedidos!
Resources
Elemento
/pedidos/{id}!

21. /getAccount!
/getAllAccounts!
/createDirectory!
/updateGroupName!
/findClientById!
RPC?

22. VERBOS

23. GET /vendas/pedidos!
POST /clientes/98W3G32K01/enderecos!
{…}
PUT /clientes/98W3G32K01/enderecos/1!
{…}
DELETE /users/98W3G32K01/photos!
PATCH /users/98W3G32K01 !
{…}

25. 3Versionamento

26. v1
v2
v3
v4
v5
v6
v7
THINGS
CHANGE!

27. Versionamento
Versão
URI:
https://api.mycompany.com/name-of-api/v2/resource!
HTTP
ou
HTTPS
Seu
domínio
Nome
da
API
(opcional)
Recursos
e
Parâmetros

28. 4Error
Handling

29. 200!
400!
500!
Resultado
OK
Erro
no
Client
Erro
no
Server

30. STATUS
OK 200!

31. Mais
informações?
Vídeo
do
Webinar
hRp://downloads.sensedia.com/webinar-­‐design-­‐de-­‐apis-­‐resYul

32. 5Segurança

33. v Acesso
não
autorizado
v Ataques
v Sobrecarga
v Confidencialidade
v Implementações
desastradas
de
clients

34. v Acesso
não
autorizado
v Ataques
v Sobrecarga
v Confidencialidade
v Implementações
desastradas
de
clients

35. þ Identificar App (?)
þ Identificar Usuário (?)
þ Identificar Device (?)
Identidade e
Autorização

36. HTTPS,
sempre!

37. 6Hypermedia

38. Hypermedia
APIs
*POX
=
Plain
Old
XML,
Richardson
Maturity
Model
HATEOAS
=
Hypermedia
as
the
Engine
of
Applica^on
State

39. GET /items?q=macbook+air+new
{!
"results" : [ !
{!
"id" : 123,!
"name" : "Macbook Air 2010 LIKE NEW", !
"price" : "499" !
}!
]!
}
SEM
Hypermedia

40. COM
Hypermedia
GET /items?q=macbook+air+new
{!
"results" : [ !
{
"_links" : [!
{"rel": "self","uri": "/items/123" },!
{"rel": "bids","uri": "/items/123/bids" },!
{"rel": "win","uri": "/items/123/bids?q=win" } !
],!
"name" : "Macbook Air 2010 LIKE NEW",!
"price" : "499"
}!
]!
}

41. 7Developers
Portal

42. Docs
incompletos,
desatualizados,
estáZcos
e
com
PDFs
de
100
páginas

43. Gemng
Started
www.twilio.com/docs!

44. Documentação
InteraZva
desenvolvedores.extra.com.br!

45. Exemplos
de
código
na
linguagem
do
developer
sendgrid.com/docs!

46. UX
(Developer
Experience)
DX

48. 8Self-­‐Service

49. Sign-­‐up
e
Tokens
de
acesso
automáZcos
stripe.com/docs!

50. REST
Console
ou
Sandbox
/
Playgroung
dev.transparencia.org.br!

51. 9Confiabilidade

52. Confiabilidade
Bugs
Problemas
de
Performance
Indisponibilidade
Mudanças
(não-­‐planejadas)
Falta
de
Suporte

53. www.sensedia.com/br!
Trace
de
calls,
Monitoramento,
Rate
LimiZng
e
Alertas

54. status.aws.amazon.com!
Status
Page,
Release
Notes,
Blog

55. Foruns
de
discussão
e
Abertura
de
Zckets
desenvolvedores.extra.com.br!

56. 10Divulgação

57. Hackathon
&
Open
InnovaZon

58. 1 Developers
Cadastrados:
800+
2 Apps
Criadas:
300+
3 Tráfego:
20M
calls
/
15
dias
4 Eleições
mais
transparentes!

59. The
Power
of
Open

60. The
Power
of
Open
hRps://www.youtube.com/watch?v=7r7QpIDEI_o

61. Design
RESTful
2
1 Proposta
de
Valor
3 Versionamento
4 Error
Handling
5 Segurança
7 Developers
Portal
6 Hypermedia
8 Self-­‐Service
9 Confiabilidade
10 Divulgação

62. Kleber
Bacili
kleber.bacili@sensedia.com
@kleberbacili
www.slideshare.net/kleberbacili/
Design
de
APIs
RESTful
–
Seguras,
Escaláveis
e
Interoperáveis
–