Você tem quem programe
Equipe interna ou fornecedor de confiança. Nesse caso, controlar a integração costuma valer mais que terceirizá-la.
API pública REST, com token por escopo e documentação aberta
A API da Prospectou: construa o que a sua operação precisa.
Uma API REST para ler e escrever contatos, acompanhar conversas e mensagens, consultar atendentes e canais e executar relatórios — autenticada por token com escopos, para cada integração ter só a permissão de que precisa.
Documentação aberta · token gerado dentro da plataforma
Conecta com
WhatsAppInstagramE-mail
DEFINIÇÃO
O que a API da Prospectou permite fazer?
Ela permite que outro sistema leia e escreva na sua operação da Prospectou: cadastrar e atualizar contatos, acompanhar conversas e mensagens do atendimento, consultar atendentes e canais, e executar relatórios. A autenticação é por token gerado dentro da plataforma, e cada token carrega apenas os escopos que você concedeu.
A API é versionada e pública: existe documentação aberta, com especificação OpenAPI, e o contrato não muda sem aviso. Isso importa porque integração que quebra sozinha é pior do que integração que não existe — alguém descobre pelo dado que parou de chegar.
O modelo de permissão é por escopo, não por “usuário administrador”. Um token de leitura de contatos não consegue enviar mensagem, e um token de relatório não enxerga conversa. É o que permite dar acesso a um parceiro sem entregar a operação inteira.
E ela é opcional. Se a sua empresa não tem quem programe, existem os outros dois caminhos: integrações nativas para o que já tem conector, e integração sob medida, construída por nós.
Os recursos disponíveis hoje
- Contatos — listar, consultar, criar e atualizar contatos, com os campos personalizados da sua operação.
- Conversas — listar e consultar atendimentos, com filtros, e acompanhar o andamento.
- Mensagens e anexos — ler o histórico de mensagens de um atendimento e os arquivos trocados nele.
- Atendentes — consultar a equipe de atendimento da organização.
- Canais — consultar os canais de atendimento configurados.
- Status de CRM e tipos de evento — os catálogos da sua organização, para escrever valores válidos em vez de adivinhar.
- Leads de prospecção — consultar os leads gerados pela busca de empresas.
- Relatórios — listar, executar e ler o resultado dos relatórios da operação.
QUANDO USAR A API
Quatro sinais de que o caminho é a API.
Nem toda integração precisa de API. Quando há conector pronto, ele é mais rápido e não exige manutenção sua.
O fluxo é específico da sua empresa
Uma regra de negócio que só faz sentido no seu contexto e que nenhum conector genérico atenderia.
Você quer alimentar um painel próprio
Levar dados de atendimento e relatórios para o BI ou o painel que a diretoria já usa.
Você é parceiro ou integrador
Constrói soluções para vários clientes e precisa de um contrato estável para trabalhar em cima.
Nos demais casos, integração nativa ou sob medida costuma custar menos esforço.
COMEÇANDO
Como começar a usar.
Do token à primeira chamada.
Gere um token
Dentro da plataforma, em configurações, você cria um token da organização e escolhe os escopos que ele terá. O valor completo aparece uma única vez.
Escolha os escopos
Conceda só o necessário: leitura de contatos, escrita de contatos, leitura de conversas, escrita em conversas, atendentes, canais, leads e relatórios.
Autentique a chamada
As requisições vão com o cabeçalho Authorization: Bearer seguido do token. Tudo é REST com JSON, sobre api.prospectou.com.
Consulte a documentação
A referência completa dos recursos, parâmetros e respostas fica aberta na Central de Ajuda, com especificação OpenAPI para gerar cliente.
Trate paginação e limites
As listagens são paginadas e há limite de requisições. A documentação traz os parâmetros e o comportamento esperado.
DECISÕES DE PROJETO
Como a API foi pensada.
Três escolhas que afetam quem vai integrar — e que vale conhecer antes de começar.
Escopo, não superusuário
Cada token carrega uma lista de permissões específicas. Não existe token “de administrador” que faça tudo por padrão.
- Escopos de leitura e de escrita separados
- Um token por integração, revogável isoladamente
- Permissão negada devolve erro claro, não silêncio
A organização vem do token
O token pertence a uma organização, e é dele que a API tira o tenant. Não existe parâmetro de organização no corpo da requisição.
Aceitar isso como parâmetro seria permitir que um cliente lesse dados de outro — o tipo de falha que só aparece quando alguém tenta.
Contrato estável e documentado
A API é versionada e publicada com especificação OpenAPI, o que permite gerar cliente automaticamente e conferir o contrato sem depender de exemplo em documentação.
Recurso novo é acrescentado; o que já existe não muda de forma sem aviso.
As mesmas regras do produto valem
Mensagem enviada pela API passa pelas mesmas verificações de uma mensagem enviada pela tela — inclusive a checagem de quem pediu para não receber mais.
Não há porta dos fundos: a API é outra entrada para as mesmas regras.
PARA CADA OPERAÇÃO
O que costuma ser construído.
Os usos mais frequentes de quem integra pela API.
ENTRADA DE LEADS
Formulário do site direto no CRM.
O site ou a landing page cria o contato pela API, já com origem e campos personalizados preenchidos — sem integração de terceiro no meio.
PAINEL PRÓPRIO
Dados de atendimento no BI da empresa.
Relatórios e dados de conversas alimentam o painel que a diretoria já usa, junto com as outras fontes da empresa.
SINCRONIZAÇÃO
Cadastro do sistema interno no CRM.
Uma rotina do lado da empresa mantém os contatos alinhados com o sistema de origem, no ritmo que fizer sentido.
FAÇA A CONTA
API própria × integração nativa × sob medida.
As três levam ao mesmo lugar. O que muda é quem constrói e quem mantém depois.
| O que a operação precisa | Integração nativa | Com a Prospectou |
|---|---|---|
| Quem constrói | Ninguém — já existe pronta | Sua equipe, pela API |
| Tempo até funcionar | Minutos, por tela | O que a sua equipe levar |
| Flexibilidade | O que o conector faz | O que você programar |
| Manutenção | Nossa | Sua |
| Casos cobertos | Bling e Asaas | Qualquer fluxo sobre os recursos expostos |
| Custo adicional | Nenhum | Nenhum — a API está incluída |
| Quando escolher | O sistema já tem conector | Você tem equipe e quer controlar |
*Há ainda a integração sob medida, em que o desenvolvimento é feito por nós — ver a página dedicada.
DOCUMENTAÇÃO
Onde encontrar a referência.
A documentação é aberta: dá para avaliar o contrato antes mesmo de criar uma conta.
Referência dos recursos
A Central de Ajuda traz a lista de recursos, parâmetros e respostas, com exemplos de chamada.
- Aberta, sem login
- Recursos e parâmetros
- Exemplos de requisição
Especificação OpenAPI
A especificação está publicada, o que permite gerar cliente automaticamente na linguagem que a sua equipe usa.
- Formato OpenAPI
- Geração de cliente
- Conferência do contrato
Quando faltar algo
Se o recurso de que você precisa não estiver exposto, o caminho é a conversa técnica — pode virar integração sob medida.
- Avaliação do caso
- Alternativa sob medida
- Resposta honesta sobre viabilidade
Onde a API se encaixa
API de CRM, API REST, token de API, escopos, OpenAPI e webhook são o vocabulário de quem vai construir. Se a sua empresa não tem quem programe, veja integrações nativas ou integração sob medida. Para entender o produto que está do outro lado da API, comece por CRM para WhatsApp.
CONTINUE
Continue por aqui
DÚVIDAS FREQUENTES
Perguntas sobre a API
A API está incluída no plano?
Sim, a API pública faz parte da plataforma. O token é gerado dentro da própria conta, com os escopos que você escolher, sem contratação separada.
Como funciona a autenticação?
Por token da organização, enviado no cabeçalho Authorization como Bearer. Cada token carrega apenas os escopos concedidos, e pode ser revogado isoladamente sem afetar as outras integrações.
Quais recursos estão disponíveis?
Contatos (leitura e escrita), conversas e mensagens do atendimento, anexos, atendentes, canais, status de CRM, tipos de evento, leads de prospecção e execução de relatórios. A referência completa está na documentação pública.
Existe documentação pública?
Sim, aberta e sem login, na Central de Ajuda, incluindo a especificação OpenAPI — o que permite gerar cliente automaticamente e avaliar o contrato antes de contratar.
A API pode enviar mensagem para o cliente?
As operações de escrita em conversas seguem as mesmas regras da plataforma, incluindo a checagem de quem pediu para não receber mais mensagens. Não existe caminho pela API que contorne essas verificações.
Um token consegue acessar dados de outra organização?
Não. A organização é determinada pelo próprio token, e não há parâmetro de organização na requisição. Aceitar isso como parâmetro seria permitir que um cliente lesse dados de outro.
Há limite de requisições?
Sim, existe limite para proteger a plataforma. Os valores e o comportamento em caso de excesso estão descritos na documentação, junto com os parâmetros de paginação das listagens.
E se eu precisar de um recurso que a API não expõe?
Vale a conversa técnica. Dependendo do caso, o caminho é uma integração sob medida, construída por nós no ambiente de scripts, que alcança mais recursos internos do que a API pública expõe.
API PÚBLICA
Construa em cima da operação, não ao lado dela.
Crie a conta, gere um token com os escopos que precisar e teste contra a documentação aberta — durante os 7 dias, sem cartão.
7 dias com tudo liberado · sem cartão de crédito · cancele quando quiser
Tudo certo! 🎉
Recebemos sua solicitação. Nossa equipe entra em contato pelo WhatsApp e e-mail informados para marcar a apresentação.