Te damos boas-vindas à documentação da API v3 do Spotter. Com ela, você pode criar integrações robustas para estender e conectar ao Spotter.

A API (Application Programming Interface ou Interface de Programação de Aplicativos) é um padrão de programação, com conjuntos de instruções cuja finalidade é desenvolver a integração entre diferentes plataformas de softwares.

Todas as nossas APIs são organizadas em torno da arquitetura REST e são acessadas via protocolo HTTPS. Então, se você já interagiu com uma API RESTful, muitos dos conceitos serão familiares.

Requisitos para começar

Possuir uma conta Exact Spotter.

Entidades

As nomenclaturas das entidades utilizadas na API deverão seguir o padrão conforme a tabela a seguir:

Spotter	API
Atividades	tasks
Bonificação	bonus
Boxes	boxes
Campos Personalizados Leads	customFields
Campos Personalizados Organização	customFieldsOrganization
Configurações de Agendamento	meetingsettings
Contatos	persons
Dashboard	dashboard
Dores	painPoints
Empresa/Organização	organization
Etapas Funil	stages
Funil	funnels
Grupos	groups
Histórico de Ligação	callsHistory
Histórico de Qualificação	qualificationHistories
Leads	leads
Leads Descartados	losts
Leads Transferidos	transferHistory
Leads Vendidos	leadsSold
Leads e Contatos	leadsAndPersons
Localização	cities
Mercado	industries
Metas	goals
Motivos de Descarte	discardReasons
Origem e sub-origem	sources
Perguntas e Respostas	answers
Pontuação	scores
Produtos	products
Produtos Sugeridos	recommendedProducts
Pré-vendedores	sdrs
Resultado de Ligação	callsResult
Reuniões	meetings
Temperatura	qualificationTemparature
Timeline	timeline
Transcrição	transcriptions
Usuário	user
Vendedores	sellers
Webhooks	webhooks
Whatsapp	whatsApp

Atividades

Gerenciamento de atividades (tasks) dos leads.

Operações disponíveis:

Listar Tipos de Atividade
Listar Atividades
Inserir Atividade
Atualizar Atividade
Concluir Atividade
Remover Atividade

Bonificação

Consulta de bonificações dos pré-vendedores.

Operações disponíveis:

Listar Bonificação

Boxes

Gerenciamento de boxes (salas/locais de reunião).

Operações disponíveis:

Listar Boxes
Inserir Box
Atualizar Box
Excluir Box

Campos Personalizados Leads

Campos customizados associados a leads.

Operações disponíveis:

Listar Campos Personalizados de Leads
Inserir Campo Personalizado Leads

Campos Personalizados Organização

Campos customizados de organizações.

Operações disponíveis:

Listar Campos Personalizados de Organização
Inserir Campo Personalizado Organização

Configurações de Agendamento

Configurações de reuniões e agendamentos.

Operações disponíveis:

Listar Configuração de Agendamento

Contatos

Gerenciamento de contatos (persons) associados a leads.

Operações disponíveis:

Listar Contatos
Buscar Contato por ID
Inserir Contato
Atualizar Contato
Excluir Contato

Dashboard

Métricas e indicadores do Dashboard do Spotter.

Operações disponíveis:

Listar atividades no funil (gerencial)
Listar Métricas da Pré-venda
Listar métricas da venda
Listar Produção da Pré-venda
Listar Produção dos vendedores
Listar Desempenho de vendas: Vendedores
Listar Desempenho de vendas: Pré-vendedores
Listar Previsão de Negócios por Mês $
Listar Previsão de Negócios por Qualificação #
Listar Previsão de Negócios por Qualificação $
Listar qualificação de reuniões
Listar Qualidade de reuniões S.Q.L
Listar Safra
Listar temperatura
Listar tempo médio por origem
Listar Feedback de ligações enviados
Listar Feedbacks de ligações solicitados

Dores

Consulta de dores (pain points) cadastradas na empresa.

Operações disponíveis:

Listar Dores

Empresa/Organização

Gerenciamento de empresas e organizações.

Operações disponíveis:

Listar Empresa/Organização
Inserir Empresa/Organização
Atualizar Empresa/Organização
Listar Campos Personalizados de Organizações

Etapas Funil

Consulta de etapas de um funil específico.

Operações disponíveis:

Listar Fases da Empresa

Funil

Consulta de funis cadastrados na empresa.

Operações disponíveis:

Listar funis da empresa

Grupos

Gerenciamento de grupos de usuários.

Operações disponíveis:

Listar Grupos
Criar Grupo
Remover Grupo
Inserir usuários
Remover usuário

Histórico de Ligação

Consulta do histórico de ligações realizadas.

Operações disponíveis:

Listar Histórico de Ligação

Histórico de Qualificação

Consulta do histórico de qualificações dos leads.

Operações disponíveis:

Listar histórico

Leads

Gerenciamento completo do ciclo de vida dos leads.

Operações disponíveis:

Listar Leads
Inserir Leads
Atualizar Leads
Excluir Lead
Descartar Leads
Recuperar Lead Descartado
Transferir Leads
Transferir Vendedor
Vender Leads
Agendar Lead
Aplicar Filtro
Mudar Funil
Pular Etapas
Listar Campos Personalizados do Lead
Listar Campos Personalizados de Leads
Excluir campo personalizado
Listar Etapas do Funil do Lead
Listar Etapas do Lead

Leads Descartados

Consulta e recuperação de leads descartados.

Operações disponíveis:

Listar Descartados

Leads Transferidos

Consulta do histórico de transferências de leads.

Operações disponíveis:

Listar Transferências

Leads Vendidos

Consulta de leads marcados como vendidos.

Operações disponíveis:

Listar Leads Vendidos

Leads e Contatos

Consulta combinada de leads e seus contatos.

Operações disponíveis:

Listar Leads e Contatos

Localização

Consulta de cidades e regiões disponíveis.

Operações disponíveis:

Listar Localização

Mercado

Consulta de segmentos de mercado cadastrados.

Operações disponíveis:

Listar Mercado

Metas

Consulta de metas definidas para usuários.

Operações disponíveis:

Listar Metas

Motivos de Descarte

Consulta de motivos de descarte de leads.

Operações disponíveis:

Listar Motivos de Descarte

Origem e sub-origem

Consulta de origens e sub-origens dos leads.

Operações disponíveis:

Listar Origem e Sub-origem

Perguntas e Respostas

Consulta de perguntas e respostas dos questionários.

Operações disponíveis:

Listar Perguntas e Respostas

Pontuação

Consulta de pontuação e scores dos leads.

Operações disponíveis:

Listar Pontuação

Produtos

Gerenciamento de produtos e produtos recomendados.

Operações disponíveis:

Listar produtos
Inserir produto
Atualizar Produto
Remover produto

Produtos Sugeridos

Gerenciamento de produtos sugeridos para leads.

Operações disponíveis:

Listar Produtos Sugeridos
Adicionar Produto Sugerido
Excluir produto sugerido

Pré-vendedores

Consulta de pré-vendedores (SDRs) cadastrados.

Operações disponíveis:

Listar pré-vendedores

Resultado de Ligação

Consulta de resultados de ligações realizadas.

Operações disponíveis:

Listar Resultado de Ligação

Reuniões

Gerenciamento de reuniões agendadas.

Operações disponíveis:

Listar Reuniões
Listar Feedbacks Pendentes

Temperatura

Consulta de temperatura de qualificação dos leads.

Operações disponíveis:

Listar Temperaturas

Timeline

Registro de eventos na timeline do lead.

Operações disponíveis:

Listar timeline
Inserir Comentário na Timeline

Transcrição

Consulta de transcrições de ligações.

Operações disponíveis:

Listar transcrição

Usuário

Gerenciamento de usuários do sistema.

Operações disponíveis:

Inserir usuário
Atualizar Usuário

Vendedores

Consulta de vendedores cadastrados na empresa.

Operações disponíveis:

Listar Vendedores

Webhooks

Configuração de webhooks para eventos da API.

Operações disponíveis:

Listar Eventos Cadastrados
Listar Eventos Disponíveis para Cadastro
Inserir Webhooks
Remover Webhook

Integração com WhatsApp Business.

Operações disponíveis:

Inserir mensagem

Domínio base

Todas as requisições para a API v3 do Spotter devem usar a seguinte URL base:

https://www.exactsales.com.br/v3

Formatos de dados

Payload

O dados da API v3 são sempre trafegados usando JSON.

Assim, o Content-Type sempre será application/json.

Data e hora

As propriedades de data e hora (DateTime) seguem o padrão ISO 8601 com timezone padrão sendo o UTC.

Autenticação

Todas as requisições para a API v3 devem ser autenticadas.

Para mais detalhes, leia sobre a autenticação.

Limite de requisições

Para garantir a estabilidade da plataforma para todos os usuários, a API impõe 30 requisições a cada 20 segundos por endpoint.

Se você exceder esse limite, receberá uma resposta com o código de status 429 Too Many Requests. A resposta incluirá um cabeçalho Retry-After indicando quantos segundos você deve esperar antes de fazer uma nova tentativa.

Status de retorno

A API v3 utiliza códigos de status HTTP padrão para indicar o sucesso ou a falha de uma requisição.

Código	Significado	Descrição
`200 OK`	Sucesso	A requisição foi bem-sucedida.
`201 Created`	Criado	O recurso foi criado com sucesso. Exemplo: em respostas do método `POST`.
`204 No Content`	Sem conteúdo	A requisição foi bem-sucedida mas não há conteúdo para retornar. Exemplo: em respostas do método `DELETE`.
`400 Bad Request`	Requisição inválida	A requisição está malformada e não consegue ser processada. Exemplo: o corpo JSON está inválido ou tem parâmetros obrigatórios ausentes.
`401 Unauthorized`	Não autorizado	O token da API está ausente ou inválido.
`403 Forbidden`	Proibido	O token não tem permissão para acessar o recurso solicitado.
`404 Not Found`	Não encontrado	O recurso solicitado não existe.
`422 Unprocessable Entity`	Entidade inválida	A entidade não pode ser processada.
`429 Too Many Requests`	Muitas requisições	O limite de requisições foi excedido.
`500 Internal Server Error`	Erro interno	Erro interno ou inesperado no servidor.

Paginação

End-points que retornam listas de recursos utilizam paginação para gerenciar grandes volumes de dados.

Por padrão, os registros são retornados em lotes de 500 registros por requisição.

Use o parâmetro de consulta $skip para navegar pelas páginas, informando quantos registros devem ser pulados. Exemplo para obter o segundo lote de registros:

https://api.exactspotter.com/v3/Leads?$skip=500

Parâmetro	Tipo	Descrição
`$skip`	`Integer`	Número de registros a serem ignorados antes de retornar os resultados. Padrão: `0`.

Para navegar entre as páginas, incremente o valor de $skip em múltiplos de 500:

Página	Parâmetro
1ª página	(sem `$skip` ou `$skip=0`)
2ª página	`$skip=500`
3ª página	`$skip=1000`
N-ésima página	`$skip=(N-1) * 500`

Requisitos para começar

Entidades

Atividades

Bonificação

Boxes

Campos Personalizados Leads

Campos Personalizados Organização

Configurações de Agendamento

Contatos

Dashboard

Dores

Empresa/Organização

Etapas Funil

Funil

Grupos

Histórico de Ligação

Histórico de Qualificação

Leads

Leads Descartados

Leads Transferidos

Leads Vendidos

Leads e Contatos

Localização

Mercado

Metas

Motivos de Descarte

Origem e sub-origem

Perguntas e Respostas

Pontuação

Produtos

Produtos Sugeridos

Pré-vendedores

Resultado de Ligação

Reuniões

Temperatura

Timeline

Transcrição

Usuário

Vendedores

Webhooks

Whatsapp

Domínio base

Formatos de dados

Payload

Data e hora

Autenticação

Limite de requisições

Status de retorno

Paginação