APIs gerenciadas de ponta a ponta

José Vahl
jose.vahl@sensedia.com
@josevahl
APIs gerenciadas de
ponta a ponta
Fábio Rosato
fabio.rosato@sensedia.com
@frosato

 Gerente de Consultoria na
Sensedia
 Professor dos cursos de pós-graduação
em SOA pelo IBMEC e
Inatel
 Atuação em diversos projetos
complexos para grandes
empresas grandes
 Cielo, Telefônica | Vivo, TIM,
Itaú, Bradesco Seguros entre
outras
Fábio Rosato

Agenda
Sobre a Sensedia
Contextualização
Proposta de valor e Design
Construção da API
Execução e instrumentalização

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

O Tempo todo
com o usuário
Compartilhando
tudo com todos
The Nexus
of Forces
Inundação de dados
e contexto
Implantanto e rodando
em algum lugar
Source: Gartner (Jun/2012)

APIs
Application Programming Interface
é a cola digital que permite:
• Acelerar parcerias
• Simplificar integração mobile-cloud
• Impulsionar a inovação aberta
• Integrar aplicações de software
• e Criar novos negócios

O tabuleiro das APIs
16
casas
Valor URI Recursos Operações
Versionamento Media Types Status Codes Filtros
Caching Segurança Callbacks Hypermedia
Documentação Construção Instrum/zação Divulgação

Plan &
Prepare
API
Strategy
Design
& Build
Run &
Engage

Plan &
Prepare
API
Strategy
Design
& Build
Run &
Engage
Plan Prepare

As primeiras decisões de design…

Selecione a Tecnologia Adequada
SOAP vs. REST

Selecione a Tecnologia Adequada
XML vs. JSON

and the winners are…
REST + JSON

1
Proposta
de valor

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

Plan &
Prepare
API
Strategy
Muitos
projetos;
Design
Equipe
& Build
pequena
Run &
Engage
Design
Design &
&
Build
Build

2
URI
Uniform Resource
Identifier

Estrutura Mínima
URI: https://api.mycompany.com/name-of-api/resource
HTTP ou
HTTPS
Seu domínio Nome da API
(opcional)
Recursos e
Parâmetros

3
Recursos

REST
Representational State Transfer
Estilo arquitetural criado por Roy Fielding
RESTful
Design que respeita os conceitos REST

Coleção
/pedidos
Resources
Elemento
/pedidos/{id}

RPC?
/getAccount
/getAllAccounts
/createDirectory
/updateGroupName
/findClientById

4
Operações

Resumo das Operações
Resource POST
(create)
GET
(read)
PUT
(update, create)
DELETE
(delete)
/pedidos Cria novo
pedido
Lista pedidos -- Apaga todos
os pedidos
/pedidos/3747 -- Mostra pedido
3747
Atualiza pedido
3747, se não
existir, cria
Apaga pedido
3747

Método de Consulta
(Cachable, Safe, Idempotente)
GET /vendas/pedidos
GET /checklist/item/4
GET
POST
PUT
DELETE
PATCH
OPTIONS
HEAD

Método para “Criação”
(Unsafe, Não-Idempotente)
POST /clientes/9833201/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

GET
POST
PUT
DELETE
PATCH
OPTIONS
HEAD
Método para “Atualização”
(Unsafe, Idempotente)
PUT /clientes/9833201/enderecos/1
{
"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
Método para Remoção
(Unsafe, Idempotente)
DELETE /pedidos/39009186
DELETE /users/9877261/photos

GET
POST
PUT
DELETE
PATCH
OPTIONS
HEAD
Método para Atualização parcial
(Unsafe, Não-Idempotente)
PATCH /users/9833201
{
"email": "joao.silva@empresa.com"
}
PATCH /pedidos/39009186
{
"status": "Cancelado"
}

GET
POST
PUT
DELETE
PATCH
OPTIONS
HEAD
OPTIONS
Quais métodos são permitidos?
OPTIONS /clientes
Allow: HEAD,GET,POST,OPTIONS
HEAD
Quero ver apenas o Header
HEAD /clientes
Date: …
Content-Type: application/json
Content-Length: 12345

5
Versionamento

THINGS
CHANGE!
v1 v2 v3 v4 v5 v6 v7

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
Outras alternativas:
• Twilio: /2010-04-01/Accounts/
• Salesforce.com: /services/data/v20.0/sobjects/Account

6
Media
Types

Media
Types
Formatos Padronizados:
application/json
application/xml
Formatos Proprietários:
vnd.{nome_empresa}.{nome_media_type}+{formato}
application/vnd.minhaempresa.pedido+json
Parâmetros no Header:
Request: Response:
Accept: application/json
Content-Type: application/json

7
Status
Codes

200
400
500
Resultado OK
Erro no Cliente
Erro no Servidor

Status &
Error Codes
200
400
500
200 OK
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
}
]

Status &
Error Codes
200
400
500
201 Created
POST /items/1234/bids
{
"amount" : 602.99
}
201 Created
Location: /items/1234/bids/100001
{
"amount" : 602.99,
"current_bid" : 510,
"winning" : true
}

Status &
Error Codes
200
400
500
400 Bad Request
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
}

Status &
Error Codes
200
400
500
Outros Comuns
401
403
404
413
429
Unauthorized
Forbidden
Not Found
Request is too Large
Too Many Requests

Status &
Error Codes
200
400
500
500 Internal Server Error
PUT /vendas/v1/pedidos/9940382
{
”status" : canceled
}
500 Internal Server Error
{
"status" : 500,
"message": ”Oops. Algo saiu errado”
}
http://en.wikipedia.org/wiki/List_of_HTTP_status_codes

8
Filtros e
Paginação

Filtros
Busca Global:
GET /search?q=macbook+air
Busca com escopo (subconjuntos):
GET /vendas/v2/pedidos?status=concluido
Respostas parciais:
GET /pedidos/123AF15J?_fields=numero,data,valor

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

9
Caching

Caching
Evite tráfego desnecessário
Latência de rede
Sobrecarga nos servidores
Atenção
 Tempo de invalidação do cache
 Sincronização em clusters

10
Segurança

 Acesso não autorizado
 Ataques
 Sobrecarga
 Confidencialidade
 Implementações
desastradas em clients

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

Realtime API Traffic
https://api.[you].com/…
Powered by
API Gateway
 Rate Limiting
 Monitoring & Alerts
 Authentication Models
 Policy Enforcement
 Exception handling
 Analytics on API Consumption
Mobile Apps Partners’ Apps
Internal Services
@Backend
API Gateway Architecture

11
Callbacks

Já chegamos?
Já chegamos?
Já chegamos?
Já chegamos?
Já chegamos?
Stop Pooling Me

Marketplace API
Chamadas Reversas:
 Consulta estoque
 Cálculo de frete
 Novo pedido recebido
https://api.mywebstore.com/v1/estoque
https://api.mywebstore.com/v1/frete
https://api.mywebstore.com/v1/pedido

12
Hypermedia

Hypermedia APIs
HATEOAS = Hypermedia as the
Engine of Application State
*POX = Plain Old XML, Richardson Maturity Model

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

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

Plan &
Prepare
API
Strategy
Design
& Build
Muitos
projetos;
Run Run Run &
&
&
Engage
Equipe
Engage
Engage
pequena

13
Documentação
interativa

Docs incompletos, desatualizados,
estáticos e com PDFs de 100 páginas

Developers
https://developers.[you].com
API Portal
API Developers Portal
 Introdução, tutoriais e
exemplos de códigos
 Self-service Signup
 Documentação interativa
(API Browsing)
 Forum, Blog & Dev support
 Testes facilitados (Sandbox)
 Dev. Dashboard
Powered by

Getting
Started
www.twilio.com/docs

Documentação
Interativa
desenvolvedores.extra.com.br

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

Sign-up e Tokens de
acesso automáticos
stripe.com/docs

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

14
Construção

15
Instrumentalização

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

API Suite
• Login / signup
• Criação de Apps
• Gestão de tokens
• Foruns e suporte
• Sandbox
• Dev Dashboard
Backend
• Autenticação
• Roteamento
• Políticas / quotas
• Degub / trace
• Monitoramento
• Gestão de tokens

www.sensedia.com/br
Trace de calls,
Monitoramento,
Rate Limiting e
Alertas

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

Foruns de discussão
e Abertura de tickets
desenvolvedores.extra.com.br

16
Divulgação

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

Execução e
instrumentalização

Fábio Rosato
fabio.rosato@sensedia.com
@frosato
José Vahl
jose.vahl@sensedia.com
@josevahl

APIs gerenciadas de ponta a ponta

Recommended

Recommended

More Related Content

Similar to APIs gerenciadas de ponta a ponta

Similar to APIs gerenciadas de ponta a ponta (20)

APIs gerenciadas de ponta a ponta