Este documento fornece 10 dicas para criar APIs RESTful seguras, escaláveis e interoperáveis. Apresenta princípios como proposta de valor, versionamento, tratamento de erros, segurança, portal para desenvolvedores, hipermídia, otimizações, confiabilidade e divulgação. O objetivo é ajudar os desenvolvedores a construírem APIs de sucesso.

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

2. Kleber Bacili
kleber.bacili@sensedia.com
@kleberbacili

3. v SOA, Microservices e APIs
v Projetos bacaníssimos
v Ferramentas sensacionais
v Headquarter em Campinas,
escritórios em SP, Rio e EUA

4. As APIs estão por
toda parte…

6. Startup BaLlefield
78%

7. The Internet
of Things

8. Startups
Battlefield
78%

10. Open API: Plataforma que permite que
empresas parceiras criem novas soluções
integradas ao banco (by Sensedia)

11. API Calls: +280%
Outubro 2014/2015
@ Sensedia API Gateway

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 conVnuará 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. THINGS
CHANGE!
v1
v2
v3 v4

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
hAp://downloads.sensedia.com/webinar-design-de-apis-resIul

32. 5Segurança

33. v Acesso não autorizado
v Ataques
v Privacidade
v Integridade
v Disponibilidade

34. v Acesso não autorizado
v Ataques
v Privacidade
v Integridade
v Disponibilidade

35. Usuários Apps
Basic HTTP OAuth2 OpenID Connect
Estratégias de AutenVcação / Autorização
App Token

36. Client Apps
APIs
Rate LimiVng Policy
JSON Threat Policy
Payload Size Policy
IP Filtering Policy
…
API Gateway

37. Os Fundamentos da
Segurança de APIs
WEBINAR
hAp://downloads.sensedia.com/webinar-seguranca-de-apis

38. 6Hypermedia

39. GET /items?q=macbook+air+new
{!
"results" : [ !
{!
"id" : 123,!
"name" : "Macbook Air 2010 LIKE NEW", !
"price" : "499" !
}!
]!
}
SEM
Hypermedia
HATEOAS = Hypermedia as the
Engine of Applica;on State

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áVcos e com PDFs de 100 páginas

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

44. desenvolvedores.cnova.com
Documentação
InteraVva

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

46. UX
(Developer Experience)
DX

47. 8OVmizações

48. Caching
Evite tráfego desnecessário
Latência de rede
Sobrecarga nos servidores

49. Filtros
GET /vendas/v2/pedidos?_status=concluido!
GET /pedidos/123AF15J?_fields=numero,data,valor!
Busca com escopo (subconjuntos):
Respostas parciais:

50. Paginação
GET /pedidos?_offset=50&_limit=25!
Recomendação:
Outras opções:
Linkedin:
Instagram:
?start=50&count=25
?min_id=3091&max_id=3245&count=25

51. 9Confiabilidade

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

53. Trace de calls,
Monitoramento,
Rate LimiVng,
Status Page e
Alertas

54. 10Divulgação

55. Hackathon & Open InnovaVon

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

57. Design RESTful 2
1 Proposta de Valor
3 Versionamento
4 Error Handling
5 Segurança
7 Developers Portal
6 Hypermedia
8 OVmizações
9 Confiabilidade
10 Divulgação

58. www.slideshare.net/kleberbacili/

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