API B2cor

URL: https://b2corapi.agencialink.com.br

Versão Atual: 1.2 – Novembro/2019

A API do B2cor permite que outros sistemas possam enviar informações e manipular dados existentes. Para utilizá-la, abra um chamado e solicite a chave da api.

Os métodos devem ser chamados através de uma requisição HTTP. Dependendo do método, a requisição deve ser GET ou POST.

Para autenticar deve ser passado o cabeçalho x-api-key em todas as requisições. O valor deste cabeçalho é diferente para cada corretora. Ele é formado por uma string de 32 caracteres de tamanho. É importante ter cuidado para não divulgá-lo, pois ele permite o acesso aos dados do sistema.

Também deve ser informado o cabeçalho Content-Type como application/json.

No caso de requisições POST, pode ser necessário enviar parâmetros adicionais no corpo da requisição. Esses parâmetros devem estar no formato JSON.

Com exceção do método que retorna a lista de indicações, nenhum método retorna quaisquer dados. A confirmação de que o método foi ou não executado deve ser identificado através do status da requisição HTTP.

  • Status 200: requisição executada
  • Status 403: a chave informada está errada;
  • Status 400: algum dos valores exigidos pelo método não foi informado (ex: id da indicação)
  • Status 405: método HTTP (GET ou POST) não aceito por este método
  • Status 500: verificar a mensagem de erro retornada

Métodos disponíveis

Indicações

ID é o identificador da indicação, que é o campo id_cliente.

URL é a url de acesso informada no início deste documento.

  • listAlllistar indicações que ainda não foram exportadas em formato JSON.
  • find: listar indicações de acordo com o filtro informado
    • POST url/lead/find
      • parâmetros POST:
        • status:
          • tipo: lista (array)
          • Limita indicações em um dos status informados
        • except_finishing_status:
          • tipo: inteiro
        • date_from:
          • Limita indicações cadastradas a partir da data informada
          • tipo: data no formato Y-m-d
        • funnel:
          • Limita indicações que estão no funil informado
          • valor: id do funil associado
          • tipo: número ou texto (string)
        • or_funnel:
          • O mesmo que o filtro acima, com a diferença que este é inclusivo e não exclusivo. Deve ser combinado com um dos outros filtros.
          • Exemplo: passando “novo” no filtro de status e “X” neste campo, serão retornadas as indicações que estão no status “Novo” OU indicações que estão no funil “X”.
        • user: id do usuário dono da indicação
  • gettraz os dados de uma determinada indicação
    • GET URL/lead/get/ID
  • markAsRead: marcar indicações que já foram exportadas para não serem exportadas novamente
    • GET URL/lead/markAsRead/ID/(0 para marcar como não-lido)
    • POST URL/lead/markAsRead/
      • parâmetros POST:
        • leads[]: ID (pode ser mais de um)
      • read: 0 OU 1
      • exemplo:
        •  curl -X POST URL/lead/markAsRead -H ‘Content-Type: application/json’ -H ‘x-api-key: CHAVEFORNECIDA -d ‘{“read”:1,”leads”: [1,2,3,4]}’
  • changeUser: altera o vendedor responsável pela indicação
    • GET URL/lead/changeUser/ID/VENDEDOR
      • vendedor é o código do vendedor no ERP, informado no campo “Código do corretor” do cadastro do usuário OUID do usuário
  • addHistory: inclui um histórico para uma determinada indicação
    • POST URL/lead/addHistory/ID
    • parâmetros POST:
      • info: texto do histórico
  • updateStatus: alterar o status de uma determinada indicação
    • POST URL/lead/updateStatus/ID
    • parâmetros POST:
      • valor: valor da venda
      • status: novo status (Tabela de status)
      • info: informação para adicionar no histórico
  • updateInfo: adicionar informações à indicação:
    • POST URL/lead/updateInfo/ID/ACAO
      • ACAO:
        • add: adicionar informações – adiciona as informações na indicação. se a indicação já tiver a informação, então inclui um novo registro
          • exceto nos parâmetros abaixo, que sempre são atualizados:
              • nome, e-mail, valor da venda, classificação, status
        • del: remover informações – para definir qual informação será removida, passar o parâmetro POST vazio
    • parâmetros POST para incluir/remover/atualizar:
      • valor: valor da venda
      • classificacao: classificação (qualidade) do lead
          • Obs: aceita um valor numérico entre 0 e 9.
      • nome: nome da indicação 
      • email: e-mail da indicação status: novo status da indicação
  • add: cadastrar nova indicação:
    • POST URL/lead/add/MODELO/ORIGEM
      • MODELO define qual a estrutura em que os dados serão recebidos. Ver os modelos disponíveis abaixo
      • ORIGEM define a origem/anúncio à qual a indicação estará associada
        • Obs: não é obrigatório, se não for informada será considerada a origem “Acesso Direto”
  • addFunnel: adicionar indicação em um novo funil. Obs: uma indicação só pode pertencer à um funil por vez!
    • POST URL/lead/addFunnel
    • parâmetros POST:
      • leads: lista (array) de objetos no seguinte padrão:
          • funnel:  ID do funil (numérico)
          • stage: ID do estágio (numérico)
          • lead: ID da indicação (numérico)
      • exemplo:
        • {"leads":[{"funnel":1,"stage":5,"lead":123456},{"funnel":1,"stage":6,"lead":123457}]}

  • removeFunnel: remove um funil de uma ou mais indicações
    • POST URL/lead/removeFunnel
    • parâmetros POST:
      • leads: lista (array) de objetos no seguinte padrão:
        • funnel:  ID do funil (numérico)lead: ID da indicação (numérico)
      • exemplo:
        • {"leads":[{"funnel":1,"stage":5,},{"funnel":1,"stage":6,}]}

Tags

  • listAlllistar todas as tags da corretora.
    • GET URL/tags/listAll
    • exemplo:
      • {
          "tags": [
            {
              "id_tag": "7",
              "tag": "Uma Tag",
              "cor": "#00c3dd",
              "corretora": "1",
              "obs": ""
            },
            {
              "id_tag": "8",
              "tag": "Outra Tag",
              "cor": "#c73d40",
              "corretora": "1",
              "obs": ""
            },
            {
              "id_tag": "115",
              "tag": "Umaoutratagnova",
              "cor": "#3d33c9",
              "corretora": "1",
              "obs": ""
            }
          ]
        }

Modelos de importação de indicações

Buzzlead

Primeiro é necessário cadastrar um Webhook no BuzzLead.

Neste Webhook, é necessário informar:

  • o link para o qual o BuzzLead enviará as indicações:
    • https://b2corapi.agencialink.com.br/lead/add/buzzlead/
    • o evento no qual serão enviadas (ou seja, em que momento a indicação será enviada para o B2cor)
  • dois cabeçalhos (Headers) para que o B2cor identifique a corretora no sistema:
      • Content-Type – application/json
      • x-api-key – chave fornecida

Obs: o número 60773 que aparece no vídeo é o código da origem. Consulte o link abaixo para saber como criar uma origem:

https://suporte.agencialink.com.br/b2cor/como-cadastrar-origem-no-b2cor/

Obs 2: No formulário de captação do BuzzLead há o campo E-mail na seção  “Dados de quem indica”. Este e-mail é utilizado para identificar qual corretor receberá a nova indicação. Caso seja informado um e-mail que não exista no sistema B2cor, a indicação não será distribuída.

0 0
Conteúdo Relacionado
  • Como criar um Funil de Vendas
  • Como criar um novo Lead no Funil de Vendas
  • Como fazer integrações Javascript (Avançado)
  • Como integrar código e pixel de conversão (Simplificado)
  • Como utilizar o B2COR Funil de Vendas
  • Integração com Exact Sales
  • Integração com PDC (Trindade)
  • Como alterar o responsável pelo marketing
  • Como incluir na assinatura da ferramenta telefones e redes sociais
  • Como enviar Cartão Digital pelo B2COR
  • Como enviar WhatsApp para cliente pelo B2COR
  • Como cadastrar novos modelos de mensagens
  • Como cadastrar e filtrar tags nas indicações no B2COR
  • Como excluir Origem/Anúncios
  • Como reativar usuário excluído no B2COR
  • Habilitando e desabilitando notificações no navegador
  • Como listar as indicações
  • Como alterar usuários
  • Como inserir usuário, supervisor e gerente
  • Como inserir unidades
  • Como inserir indicação no B2COR
  • Como usar o relatório diário de atividades
  • Como inserir informação no histórico de negociação do cliente
  • Como usar a Ferramenta de Feedback no B2COR
  • Como usar o B2COR Analytics para emitir relatório de análise
  • Como enviar e-mails pré-programados
  • Como realizar o agendamento de retorno a um cliente
  • Como alterar a assinatura e o logo da sua corretora no Simulador
  • Como usar a ferramenta de DISTRIBUIÇÃO EM LOTE
  • Entenda o Distribuidor Automático de Indicações
  • Como distribuir indicações no B2COR
  • Como excluir indicações em lote
  • Como alterar o responsável pelas indicações
  • Como reciclar indicações
  • Como alterar dados no B2COR
  • Como cadastrar Origem/Anúncios
  • Como excluir indicação duplicada
  • Como desativar um Corretor dentro do B2COR
  • Como importar lista de contatos com indicações no B2COR
  • Como acessar o Painel do Cliente
  • Como inserir Corretor no B2COR
  • Como definir padrão de Permissões do Corretor
  • Como identificar o número de Corretores cadastrados no B2COR
  • Como excluir um Corretor cadastrado no B2COR
  • Como visualizar ou excluir usuários administrativos cadastrados