Contextualização de APIs Restfull, design e exemplos.

1. Hands-on https://www.getpostman.com/collections/8bfc64a96cffc06b9a95

3. #InternetOfThings
#OpenInnovation
#MultiPlatform
#Omminichannel

14. /pedidos
/pedidos/{id}

15. /getAccount
/getAllAccounts
/createDirectory
/updateGroupName
/findClientById

16. https://api.mycompany.com/name-of-api/resource

18. /pedidos
/pedidos/3747

19. GET /vendas/pedidos
GET /checklist/item/4
GET
POST
PUT
DELETE
PATCH
OPTIONS
HEAD

20. POST /clientes/98W33GJ201/enderecos
{
"endereco": "Av. Brigadeiro Faria Lima",
"numero": "3800",
"complemento": "18o. Andar",
"bairro": "Itaim Bibi",
"cidade": "São Paulo",
"estado": "SP",
"cep": "04538-132"
}
GET
POST
PUT
DELETE
PATCH
OPTIONS
HEAD

21. GET
POST
PUT
DELETE
PATCH
OPTIONS
HEAD
PUT /clientes/98W33GJ201/enderecos/1
{
"endereco": "Av. Brigadeiro Faria Lima",
"numero": "3800",
"complemento": "18o. Andar",
"bairro": "Itaim Bibi",
"cidade": "São Paulo",
"estado": "SP",
"cep": "04538-132"
}

22. GET
POST
PUT
DELETE
PATCH
OPTIONS
HEAD
DELETE /pedidos/98W33GJ201
DELETE /users/98S7726QV1/photos

23. GET
POST
PUT
DELETE
PATCH
OPTIONS
HEAD
PATCH /users/98W33GJ201
{
"email": "joao.silva@empresa.com"
}
PATCH /pedidos/39D0091B86
{
"status": "Cancelado"
}

24. GET
POST
PUT
DELETE
PATCH
OPTIONS
HEAD
OPTIONS /clientes
Allow: HEAD,GET,POST,OPTIONS
HEAD /clientes
Date: …
Content-Type: application/json
Content-Length: 12345

26. Documentação
v1
v2
v3
v4

27. https://api.mycompany.com/name-of-api/v2/resource
•
•
Versionamento
Nunca quebre o cliente!!

28. 200
400
500
201
202
401
405
413
429
503
Status Code

29. OK 200

30. 200
400
500
GET /candidatos?estado=SP&partido=PP
200 OK
[
{
"id": "1532962",
"apelido": "PAULO MALUF",
"nome": "PAULO SALIM MALUF",
"numero": "1111",
"cargo": "Deputado Federal",
"estado": "SP",
"partido": "PP",
"reeleicao": true
}
]

31. 200
400
500
POST /items/1234/bids
{
"amount" : 602.99
}
201 Created
Location: /items/1234/bids/100001
{
"amount" : 602.99,
"current_bid" : 510,
"winning" : true
}

32. 200
400
500
GET /candidatos
400 Bad Request
{
"status" : 400,
"code" : 40377,
"message" : "Parâmetro 'estado' não
pode ser nulo ou vazio"
"more" : https://dev.empresa.com/errors/40377
}

33. 200
400
500
401
403
404
413
429

34. 200
400
500
PUT /vendas/v1/pedidos/9940382
{
”status" : canceled
}
500 Internal Server Error
{
"status" : 500,
"message": ”Oops. Algo saiu errado”
}

35. GET /vendas/v2/pedidos?status=concluido
GET /pedidos/123AF15J?_fields=numero,data,valor
GET /search?q=macbook+air

36. GET /pedidos?_offset=50&_limit=25

37. http://martinfowler.com/articles/richardsonMaturityModel.html
Hypermedia

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

39. 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"
}
]
}

42. ● Políticas de Rate Limiting / Throttling
● JSON / XML Threat Protection
● Limites de tamanho de Payload
● IP Filtering (Blacklists e Whitelists)

45. User
Client
Server
Uma pessoa usando um
serviço. Se chama
“resource owner”
Uma app usada para acessar
o serviço. Se chama de
“consumer”.
É onde o serviço está
rodando. Se chama de
“service provider”.
Web access
API access
OAuth
Protocol