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

Front-end é a interface visual
Ele conecta o usuário com as APIs que estão no Back-end

API do Agendor

Permite fazer requisições ao servidor do Agendor

Requisição?

Uma requisição é uma chamada feita por um cliente para um servidor

Internet

Para navegar na Internet, nosso computador precisa fazer requisições

Carta = Requisição/Request

Carteiro = Chrome, Firefox, etc

Remetente

Destinatário

1

2

Destinatário = URL do Servidor

Remetente = Cliente

Cliente

Servidor

Requisição

Exemplos de requisição

Exemplos de requisição

Requisição

API do Agendor

https://api.agendor.com.br

Toda requisição é feita para uma URL

URL

URL

API do Agendor

https://api.agendor.com.br

  • Requisição
    • URL
      • Rota (endpoints)
      • Parâmetros

URL

Rota

Parâmetros

Clique em "Editar" meu usuário

Rota /users da API

API do Agendor

https://api.agendor.com.br

  • Requisição
    • URL
      • Rota (endpoints)
      • Parâmetros
    • Cabeçalhos (headers)
    • Corpo (body)

Rota /people

  1. Abrir Postman
  2. Fazer request do tipo GET
  3. URL:  https://api.agendor.com.br/v3/people
  4. Clicar em Send

Listar todas as pessoas

Acessem sua conta pessoal do

Agendor e copiem o token da tela de Integrações

Rota /people

  1. Abrir Postman
  2. Fazer request do tipo GET
  3. URL:  https://api.agendor.com.br/v3/people
  4. Headers
Authorization    Token <SEU-TOKEN>
  5. Clicar em Send

Listar todas as pessoas

Rota /people

  1. Nova aba no Postman (CTRL + T)
  2. Fazer request do tipo POST
  3. URL:  https://api.agendor.com.br/v3/people
  4. Headers
Authorization    Token <SEU-TOKEN>
  5. Body
name             Fulano
  6. Clicar em Send

Criar uma pessoa

  • Requisição
    • URL
      • Rota (endpoints)
      • Parâmetros
    • Cabeçalhos (headers)
    • Corpo (body)
  • Resposta (Response)
    • Cabeçalhos (headers)
      • Status code
    • Corpo (body)

Anotem esse ID

Rota /people

  1. Alterar método POST para PUT
  2. URL:  https://api.agendor.com.br/v3/people/19750896 
  3. Headers
Authorization    Token <SEU-TOKEN>

    Content-type     application/json

  4. Definir Body como raw 

  5. Body
{ "contact": {"email":"bob@siricascudo.com" } }
  6. 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

Rotas

  • GET /users
  • POST /organizations/upsert
  • POST /people/upsert
  • POST /deals

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?

Rotas

  • POST /organizations/upsert
  • POST /people/upsert

3. Quando uma empresa/pessoa for criada/alterar no Agendor, criar/alterar também essa empresa/pessoa no ERP

O que dá pra fazer

com a nossa API?

Rotas

  • Webhooks
  • ou
  • GET /organizations/stream?since=2018-06-05T00:00:00Z
  • GET /people/stream?since=2018-06-05T00:00:00

Por hoje é só!

Workshop API V3 (2020)

By Tulio Monte Azul

Made with Slides.com

Workshop API V3 (2020)

  • 113

More from Tulio Monte Azul