Workshop sobre API
Tulio Monte Azul
API
Application Programming Interface
interface
substantivo
Elemento que proporciona uma ligação física ou lógica entre dois sistemas ou partes de um sistema que não poderiam ser conectados diretamente.
User Interface (UI)
Application Programming Interface (API)
Em outras palavras
UI = Front-end
API = Back-end
quem faz front faz back
- Lidi
API do Agendor
Serve para fazer requisições ao servidor do Agendor
Internet
Requisição?
Redes
Conecta/Interliga computadores
Rede local
Rede global
Nosso Wifi
Internet
Precisa de cabo ou de roteador
Precisa de cabo ou de um roteador
+
Conexão com um provedor (TIM, MundiVox)
Rede Local
Rede Global
Rede Local
Internet
Redes
Requisição
Carta = Requisição/Request
Carteiro = Chrome, Firefox, etc
Cliente
Servidor
1
2
3
4
Exemplos de requisição
Exemplos de requisição
Internet
Redes
Requisição
API do Agendor
https://api.agendor.com.br
- Requisição
- URL
- Rota (endpoint)
- Parâmetros
- URL
Rota /plans
(não documentada)
URL
Rota
Parâmetros
API do Agendor
https://api.agendor.com.br
- Requisição
- URL
- Rota (endpoints)
- Parâmetros
- Cabeçalhos (headers)
- Corpo (body)
- URL
Rota /people
- Abrir Postman
- Fazer request do tipo GET
- URL: https://api.agendor.com.br/v1/people
- Authorization > Basic Auth
- Email: t@t.com
- Senha: 123
- Clicar em Update request
- Clicar em Send
Listar todas as pessoas
Rota /people
- Abrir Postman
- Authorization > No Auth
- Fazer request do tipo POST
- URL: https://api.agendor.com.br/v1/people
-
Headers Authorization Token <SEU-TOKEN>
-
Body name Fulano
- Clicar em Send
Criar uma pessoa
- Requisição
- URL
- Rota (endpoints)
- Parâmetros
- Cabeçalhos (headers)
- Corpo (body)
- URL
- Resposta (Response)
- Cabeçalhos (headers)
- Status code
- Corpo (body)
- Cabeçalhos (headers)
Anotem esse ID
Rota /people
- Abrir Postman
- Fazer request do tipo PUT
- URL: https://api.agendor.com.br/v1/people/14309858
-
Headers Authorization Token <SEU-TOKEN>
-
Body emails ["fulano@example.com"]
- Clicar em Send
Alterar o e-mail de uma pessoa
O que dá pra fazer
com a nossa API?
1. Quando um lead preencher um formulário no site do cliente, criar uma empresa/pessoa com nome, email e telefone e um negócio na etapa 1 pra um vendedor aleatório
2. Quando uma empresa/pessoa for criada/alterada no ERP, criar/alterar também essa empresa ou pessoa no Agendor
O que dá pra fazer
com a nossa API?
3. Quando uma empresa/pessoa for criada/alterar no Agendor, criar/alterar também essa empresa/pessoa no ERP