Como usar a API de Pesquisa de Domínio

Este artigo descreve a API de Pesquisa de Domínio da Snov.io, o processo geral de uso, as solicitações disponíveis, seus parâmetros e respostas.

Pesquisa de Domínio (solicitar informações da empresa)

Pesquisa de Domínio (obter informações da empresa)

Buscar prospects por domínio

Obter prospects de um domínio

Buscar o endereço de e-mail de um prospect

Obter o endereço de e-mail de um prospect

Buscar e-mails por domínio

Obter e-mails de um domínio

Vamos revisar os endpoints disponíveis na API de Pesquisa de Domínio, seu propósito dentro do fluxo de trabalho geral e seus principais parâmetros.

Antes de fazer qualquer solicitação à Snov.io, use o endpoint de autenticação para obter o access_token. Use-o como um token do tipo bearer para suas próximas solicitações. O tempo de vida do access_token é de 1 hora (3600 segundos).

Pesquisa de Domínio (solicitar informações da empresa)

Tipo de solicitação: POST

URL da solicitação: https://api.snov.io/v2/domain-search/start/

Este é um endpoint base que envia uma solicitação à API da Snov.io para buscar informações de uma empresa usando um domínio fornecido.

Parâmetros de entrada:

No campo "domain" desta solicitação, insira o nome de domínio (site da empresa) que deseja pesquisar.

A resposta contém dois itens principais:

• Um "task_hash" exclusivo que identifica sua solicitação. Você usará esse identificador na próxima solicitação para obter os resultados da pesquisa.
• Uma URL direta (no campo "result") para recuperar os resultados da pesquisa (obter informações da empresa).

Pesquisa de Domínio (obter informações da empresa)

Tipo de solicitação: GET

URL da solicitação: https://api.snov.io/v2/domain-search/result/{task_hash}

Use esta solicitação para recuperar os resultados da pesquisa gerados pela solicitação anterior.

Parâmetros de entrada:

Esta solicitação não requer nenhum parâmetro. Adicione o "task_hash" à URL ou use o link direto fornecido na resposta anterior.

A resposta desta solicitação contém:

• Detalhes da empresa (localização, site, nome, telefone da matriz, setor, tamanho, etc.).
• Contagem de contatos por tipo (prospects, e-mails do domínio, contatos genéricos).

No campo "links" da resposta, você encontrará URLs diretas para pesquisar e filtrar contatos por tipo: "prospects", "domain_emails", "generic_contacts". Use essas URLs em suas solicitações subsequentes.

Buscar prospects por domínio

Tipo de solicitação: POST

URL da solicitação: https://api.snov.io/v2/domain-search/prospects/start?domain=

Use este endpoint para enviar uma solicitação à API da Snov.io para pesquisar perfis de prospects no domínio fornecido.

Parâmetros de entrada:

• No campo "domain" desta solicitação, insira o nome de domínio (site da empresa) que você deseja pesquisar.
• Use o parâmetro "page" para especificar qual página de resultados você deseja pesquisar para prospects.

Paginação nos resultados da API:

Por padrão, qualquer solicitação sem o parâmetro "page" pesquisa automaticamente a primeira página de resultados. Para pesquisar em outra página, especifique o número da página nos parâmetros da solicitação.

No parâmetro "positions", liste os títulos de cargos pelos quais você deseja filtrar, como um array (máximo de 10). Coloque-os entre colchetes, separados por vírgulas. Por exemplo: positions[]: [Developer, Product Manager, Software Engineer]

A resposta contém dois itens principais:

• Um "task_hash" exclusivo que identifica sua solicitação. Você usará esse identificador na próxima solicitação para obter os resultados da pesquisa.
• Uma URL direta para a próxima solicitação (no campo "result") para recuperar os resultados da pesquisa.

Obter prospects de um domínio

Tipo de solicitação: GET

URL da solicitação: https://api.snov.io/v2/domain-search/prospects/result/{task_hash}

Use esta solicitação para recuperar os resultados da pesquisa de prospects gerados pela solicitação anterior.

Parâmetros de entrada:

Esta solicitação não requer parâmetros. Adicione o "task_hash" à URL ou use o link direto fornecido na resposta anterior.

A resposta desta solicitação contém:

A resposta fornece detalhes sobre os prospects encontrados no domínio. Cada prospect contém os seguintes campos:

• "first_name" (primeiro nome)
• "last_name" (sobrenome)
• "position" (cargo)
• "source_page" (página de origem)
• "search_emails_start" (início do e-mail de pesquisa)

Paginação nos resultados da API:

Cada solicitação retorna resultados para uma página. Se você não especificar o parâmetro "page" em sua solicitação anterior, a primeira página será retornada por padrão.

O campo "total_count" mostra o número total de prospects para o domínio. Se houver mais páginas disponíveis, você verá um campo "next" com a URL para recuperar a próxima página de resultados.

Importante:

Os endereços de e-mail não estão incluídos na resposta desta solicitação. Para encontrar o endereço de e-mail de um prospect, use a URL fornecida no campo "search_emails_start" para aquele prospect. O link inclui um "prospect_hash" único para cada prospect. Cada prospect é consultado com uma solicitação separada.

Se a pesquisa ainda estiver em andamento, a resposta mostrará "in_progress". Assim que a pesquisa estiver "completada" e o endereço de e-mail for encontrado, ele será incluído na resposta.

A resposta desta solicitação contém:

A resposta inclui o endereço de e-mail do prospect e seu status de verificação, que pode ser válido (verde) ou desconhecido (amarelo). Saiba mais sobre os status de e-mail.

Buscar e-mails por domínio

Tipo de solicitação: POST

URL da solicitação: https://api.snov.io/v2/domain-search/domain-emails/start?domain=

Use este endpoint para enviar uma solicitação à API da Snov.io para buscar e-mails de domínio no domínio fornecido.

Um e-mail de domínio é um endereço de e-mail não verificado que pertence ao domínio de uma empresa. Pode ser o endereço de e-mail de um funcionário ou um endereço de e-mail genérico.

Parâmetros de entrada:

No campo "domain" desta solicitação, insira o nome de domínio (site da empresa) que você deseja pesquisar.

A resposta contém dois itens principais:

• Um "task_hash" exclusivo que identifica sua solicitação. Você usará esse identificador na próxima solicitação para obter os resultados da pesquisa.
• Uma URL direta (no campo "result") para recuperar os resultados da pesquisa.

Se a pesquisa ainda estiver em andamento, a resposta mostrará "in_progress". Assim que a pesquisa estiver "completada", os endereços de e-mail serão incluídos na resposta.

A resposta desta solicitação contém:

• A resposta fornece uma lista de endereços de e-mail encontrados no domínio.

Paginação nos resultados da API:

• Uma solicitação fornece até 50 e-mails (uma página de resultados). A primeira página é retornada por padrão.
• O campo "total_count" na resposta mostra o número total de e-mails disponíveis.
• Se houver mais páginas disponíveis, você receberá a URL para recuperar a próxima página de resultados no campo "next".
• O campo "next" na resposta fornece a URL que você pode usar para solicitar a próxima página de resultados.

Nota: O status de verificação de e-mail não está incluído nesta resposta. Para verificar os e-mails de domínio, use a API de Verificação de E-mail.

Buscar contatos genéricos por domínio

Tipo de solicitação: POST

URL da solicitação: https://api.snov.io/v2/domain-search/generic-contacts/start

Use este endpoint para enviar uma solicitação à API da Snov.io para buscar contatos genéricos no domínio fornecido.

Um contato genérico é um endereço de e-mail não verificado do domínio da empresa, frequentemente utilizado para e-mails técnicos ou de serviço, como info@dominio.com.

Parâmetros de entrada:

No campo "domain" desta solicitação, insira o nome de domínio (site da empresa) que você deseja pesquisar.

A resposta contém dois itens principais:

• Um "task_hash" único que identifica sua solicitação. Você usará esse identificador na próxima solicitação para obter os resultados da pesquisa.
• Uma URL direta (no campo "result") para recuperar os resultados da pesquisa.

Obter contatos genéricos de um domínio

Tipo de solicitação: GET

URL da solicitação: https://api.snov.io/v2/domain-search/generic-contacts/result/{task_hash}

Use esta solicitação para recuperar os resultados da pesquisa gerados pela solicitação anterior.

Parâmetros de entrada:

Esta solicitação não requer parâmetros adicionais. Adicione o "task_hash" ao final da URL ou use o link direto fornecido na resposta anterior.

Se a pesquisa ainda estiver em andamento, a resposta mostrará "in_progress". Assim que a pesquisa estiver "completada", os resultados serão incluídos na resposta.

A resposta desta solicitação contém:

A resposta fornece uma lista de contatos de e-mail genéricos encontrados no domínio.

Paginação nos resultados da API:
Uma solicitação fornece até 50 contatos (uma página de resultados). A primeira página é retornada por padrão.
O campo "total_count" na resposta mostra o número total de contatos disponíveis. Se houver mais páginas disponíveis, você receberá a URL para recuperar a próxima página de resultados no campo "next".

Nota: O status de verificação de e-mail não está incluído nesta resposta. Para verificar os e-mails de domínio, use a API de Verificação de E-mail.

Custo de crédito da API de Pesquisa de Domínio

Cada solicitação do tipo POST à API de Pesquisa de Domínio irá descontar um crédito da sua cota de conta.

A solicitação não descontará créditos nas seguintes situações:

1. A solicitação não fornecer resultados (por exemplo, nenhuma informação sobre a empresa, nenhum prospecto ou nenhum e-mail na resposta)
2. A solicitação de pesquisa não encontrar nenhum e-mail verificado (verde ou amarelo) para um prospecto.

Veja as informações técnicas completas em nossa documentação da API de Pesquisa de Domínio.