Documentação API do Auto Business

Introdução

API Auto Business é uma API para integração com o CRM dentro do sistema do Auto Business. Esta documentação tem como objetivo descrever os endpoints disponíveis, bem como os parâmetros de entrada e saída das chamadas da API.

Autenticação

Todas as chamadas da API Auto Business devem ser autenticadas. A autenticação é realizada utilizando o protocolo OAuth 2.0. Para obter as credenciais de acesso, o cliente deve acessar o painel de configurações da sua conta dentro do sistema do Auto Business e clicar na aba "API". Após, ele deve gerar um novo token de acesso (passo 3). Esse token deve ser utilizado para autenticar as chamadas da API. O token de acesso deve ser enviado no cabeçalho HTTP Authorization com o valor "Bearer {token}".

Token

Entre em contato com suporte@inffus.com.br para solicitar seu token de acesso (Bearer token).

Endpoint 1

Inserir negócios no CRM do Auto Business.

Requisição

POST https://api.autobusiness.com.br/v1/inserir-leads
Autenticação: Token Bearer

Parâmetros

  • site (string, obrigatório): Url do seu site cadastrado no Auto Business.
  • nomeCliente (string, obrigatório): Nome do cliente.
  • emailCliente (string, obrigatório): Email do cliente.
  • dataCadastro (datetime, obrigatório): Data de cadastro do lead no formato Y-m-d H:m:s (2024-10-06 02:16:22).
  • titulo (string, obrigatório): Título do negócio, de preferência no formato "Negócio nomeCliente".
  • idVendedor (integer, obrigatório): Id do vendedor relacionado ao lead. Deve ser consultado através do endpoint de listagem.
  • etapaFunil (integer): Etapa do lead no kanban (1 - cliente potencial | 2 - proposta realizada | 3 - visita realizada | 4 - em negociação | 5 - compra realizada | 6 - contato desqualificado)
  • url (string): Url de captura do lead.
  • source (string): Fonte do lead (facebook, twitter, blog, newsletter, etc.).
  • medium (string): Meio como esse lead foi capturado (orgânico, pago, email, etc.).
  • valor (float): Valor do negócio (preço do carro, por exemplo) no formato 349.900,00.
  • placa (string): Placa do veículo.
  • probabilidade (integer): Probabilidade desse lead converter de 0 a 10.
  • finalEstimado (date): Provavél data de fechamento do negócio no formato Y-m-d (2024-10-06).
  • descricao (string): Descrição do negócio.

Exemplos:


    curl -X POST -H 'Authorization: Bearer $ACCESS_TOKEN' -H "Content-Type: application/json" -d

    {
        "site": "seusite.com.br",
        "nomeCliente": "Fulano da Silva",
        "emailCliente": "fulanodasilva@fulano.com.br",
        "dataCadastro": "2023-03-20 10:50:00",
        "titulo": "Negócio Fulano da Silva",
        "idVendedor": "1234",
        "etapaFunil": "1",
        "url": "www.google.com.br",
        "source": "google",
        "medium": "pago",
        "valor": "349.900,00",
        "placa": "XXX1X23",
        "probabilidade": "7",
        "finalEstimado": "2023-07-20 10:00:00",
        "descricao": "Lead capturado através do Google com grande probabilidade de converter."
    }
    https://api.autobusiness.com.br/v1/inserir-leads
                    
                

    201 Created
    Content-Type: application/json
    {
        "Resultado": "Sucesso"
        "Mensagem": "Seu negócio foi incluído no nosso CRM"
    }
                    
                

    400 Bad Request
    Content-Type: application/json
    {
        "Resultado": "Erro"
        "Mensagem": "Os seguintes campos precisam ser informados: campo1 campo2 campo3"
    }

Endpoint 2

Listar negócios, clientes ou vendedores que estão cadastrados no CRM do Auto Business.

Requisição

POST https://api.autobusiness.com.br/v1/listar
Autenticação: Token Bearer

Parâmetros

  • site (string, obrigatório): Url do seu site cadastrado no Auto Business.
  • modulo (string, obrigatório): Nome do módulo a ser listado ("negocios", "clientes" ou "vendedores").

Exemplo de requisição:


    curl -X POST -H 'Authorization: Bearer $ACCESS_TOKEN' -H "Content-Type: application/json" -d

    {
        "site": "seusite.com.br",
        "modulo": "negocios",
    }
    https://api.autobusiness.com.br/v1/listar
                    
                

    200 OK
    Content-Type: application/json

    [
        {
            "idNegocio": "1234",
            "titulo": "Negócio de Fulano",
            "idCliente": "123",
            "nomeCliente": "Fulano da Silva",
            "emailCliente": "fulano@silva.com",
            "vendedor": {
                "idUsuario": "1",
                "nome": "Vendedor fulano",
                "email": "vendedor@fulano.com.br"
            }
        },
        {
            "idNegocio": "1235",
            "titulo": "Négocio de Fulana",
            "idCliente": "124",
            "nomeCliente": "Fulana da Silva",
            "emailCliente": "fulana@silva.com",
            "vendedor": "Não relacionado"
        },
    ]
                        
                    

    400 Bad Request
    Content-Type: application/json
    {
        "Resultado": "Erro",
        "Descrição": "Você precisa especificar um módulo corretamente"
    }