Resumo:
- O que é uma API e como funciona
- Vantagens de usar a API da Snov.io
- Como testar a API da Snov.io
Etapa 1. Inscrever-se no Postman
Etapa 2. Configurações gerais de chamada de API
Etapa 3. Obter um token de acesso à API
Etapa 4. Fazer uma chamada de API de teste - Chamadas de API da Snov.io
- Limites de API da Snov.io
Automatize tarefas no seu fluxo de trabalho do Snov.io, integre a Snov.io diretamente à sua plataforma e recupere endereços de e-mail do nosso banco de dados. A API REST do Snov.io torna tudo isso possível!
O que é uma API e como funciona
Vamos aprender o básico rapidamente e nos familiarizar com o conceito de API e como ela funciona.
API é a sigla em inglês para Interface de Programação de Aplicativos, e é usada para comunicação entre softwares. É uma maneira de os aplicativos conversarem e interagirem uns com os outros e fornecerem os dados ou funções quando solicitado.
Pense nela como uma “sala de bate-papo“, em que um aplicativo ou software faz um pedido para outro e obtém uma resposta em tempo real. A única maneira de se comunicar nessa “sala de bate-papo” é por meio de “perguntas” ou “comandos” predefinidos (chamadas de API), e o servidor envia uma resposta.
Portanto, uma chamada de API é um processo em que um cliente (você) envia uma solicitação para a API de um servidor (Snov.io) e obtém uma resposta.
Os quatro métodos mais comuns de solicitação de API são:
- GET: recuperar dados de um servidor na URL especificada
- POST: enviar dados para um servidor
- DELETE: excluir o recurso na URL especificada
- PUT: enviar dados para criar ou atualizar um recurso
Se um cliente (você) fizer uma pergunta correta, com os parâmetros corretos, o servidor (Snov.io) devolverá os dados solicitados ou uma resposta que confirme a conclusão da ação solicitada.
Vantagens de usar a API da Snov.io
A API da Snov.io é uma ótima oportunidade para você ampliar a funcionalidade do seu aplicativo/site.
Com a API da Snov.io, você pode:
- Criar uma integração personalizada entre o Snov.io e seu aplicativo/CRM personalizado
- Solicitar que o Snov.io compartilhe os dados e aprimore o seu serviço
- Desencadear ações relacionadas ao gerenciamento de clientes potenciais (p.ex., criar uma nova lista de clientes potenciais, adicionar um cliente potencial a uma lista etc.)
- Aproveitar os recursos de Localização de e-mails e Verificação de e-mails
- Recuperar informações estatísticas sobre suas campanhas de gotejamento por e-mail
A Snov.io oferece o tipo de API REST para facilitar seu uso. Na API REST, os dados e as funções são fornecidos como recursos disponíveis como URLs exclusivas. Para pedir ao Snov.io para compartilhar dados por meio da API, você só precisa inserir a URL, definir parâmetros de consulta e autenticar sua solicitação.
Como testar a API da Snov.io
A forma mais fácil de ver como funciona a API da Snov.io é usar uma ferramenta de teste de API. Usaremos o Postman porque é conhecido, relativamente fácil de usar e tem uma versão gratuita.
Vamos fazer sua primeira chamada de API para o Snov.io a partir do Postman!
Etapa 1. Inscrever-se no Postman
Inscreva-se no aplicativo Postman no site oficial e crie sua conta.
Na aba Home (1), clique no botão Send a request (2) para ir até o ambiente de teste da API.
Etapa 2. Configurações gerais de chamada de API
Cada solicitação à API do Snov.io consiste em:
- Método de solicitação: POST ou GET (1)
- URL: endereço HTTPS da solicitação (2)
- Parâmetros de entrada: chave e valor (3)
- Saída/Resposta: dados solicitados ou uma resposta de conclusão de solicitação (4)
Veja onde inserir as configurações de chamada de API no ambiente de teste do Postman:
Dica: para solicitações GET, insira os parâmetros de entrada na aba Params. Para solicitações POST, insira-os na aba Body → aba Form Data.
Etapa 3. Obter um token de acesso à API
Antes de fazer uma solicitação, você precisa gerar um token de acesso para autenticar suas futuras chamadas de API no Snov.io e se identificar como cliente do Snov.io na “sala de bate-papo” da API do Snov.io.
Um token de acesso é seu “crachá” pessoal, que você precisa apresentar sempre que fizer uma chamada de API ao Snov.io.
Em todas as solicitações à API do Snov.io, esse token de acesso precisa ser especificado no campo Authorization (já explicaremos como fazer isso no Postman).
As configurações de chamada de API do token de acesso são as seguintes:
- (1) Tipo: POST
- (2) URL de solicitação: https://api.snov.io/v1/oauth/access_token
Parâmetros de entrada:
Chave | Valor |
grant_type (1) | client_credentials |
client_id (2) | ID de usuário, que você pode encontrar nas configurações da conta |
client_secret (3) | Segredo de API, que você pode encontrar nas configurações da conta |
Após inserir todos os parâmetros, clique no botão Send (1) e obtenha seu token de acesso (2) na seção Output/Response. Salve-o ou copie-o para usar em futuras chamadas de API.
Observação 1: por motivos de segurança, o token de acesso dura 3.600 segundos (1 hora). Você precisará gerar um novo token de acesso a cada hora.
Observação 2: o tipo de token é Bearer. Você precisará especificar o tipo de token ao autorizar sua próxima solicitação.
Agora vamos aprender algumas das chamadas de API que você pode direcionar à API do Snov.io.
Etapa 4. Fazer uma chamada de API de teste
- Pesquisa de domínios V.2
Você pode pedir à API do Snov.io para compartilhar até 100 e-mails de domínio por chamada. Custa 1 crédito para cada 10 e-mails/clientes potenciais fornecidos em resposta.
Para autenticar sua chamada de API no Postman:
Vá para a aba Authorization (1) no Postman, escolha o tipo Bearer Token (2) e cole seu token de acesso (3).
Volte à aba Params para inserir as configurações de chamada da API de Pesquisa de domínios:
- (1) Tipo: GET
- (2) URL de solicitação: https://api.snov.io/v2/domain-emails-with-info
- (3) Parâmetros de entrada:
Chave | Valor |
domain | nome do domínio no qual você deseja encontrar endereços de e-mail |
type | tudo, pessoal ou genérico |
limit | número de e-mails que você deseja receber de um domínio (máx. 100) |
lastId | o valor padrão é 0. Para obter mais de 100 e-mails de um domínio, na sua próxima solicitação, indique o valor de resposta last_id da solicitação anterior |
position or positions | insira um cargo específico para filtrar os clientes potenciais que você deseja obter a partir de um domínio |
Observação 1: se você pedir endereços de e-mail genéricos, você receberá endereços de e-mail baseados em funções, como contato@snov.io. Endereços de e-mail pessoais são aqueles das pessoas que trabalham na empresa. Se você especificar o tipo “tudo“, receberá e-mails pessoais e genéricos.
Observação 2: para obter mais de 100 e-mails de um domínio, na sua próxima solicitação, indique o valor de resposta last_id da solicitação anterior.
Após inserir todas as configurações, clique no botão Send para ver os endereços de e-mail de que o Snov.io dispõe para compartilhar.
- Verificador de e-mails
Com a API do Snov.io, você pode verificar se os endereços de e-mail fornecidos são válidos. Essa chamada de API não custa créditos.
Primeiro, autentique sua chamada de API com um token de acesso na aba Authorization.
A seguir, abra a aba Body → a aba Form Data no Postman, e insira as configurações de chamada da API do Verificador de e-mails:
- (1) Tipo: POST
- (2) URL de solicitação: https://api.snov.io/v1/get-emails-verification-status
- (3) Parâmetros de entrada:
Chave: emails[]; Valor: uma matriz (lista) de endereços de e-mail que você gostaria de verificar.
Após inserir todos os parâmetros, clique no botão Send para ver o status do e-mail na seção Output/Response: “valid”, “not_valid”, “greylisted” ou “unknown”.
Se você receber um identificador “not_verified” no campo Output/Response, significa que não verificamos esse endereço de e-mail antes. Você precisa usar a chamada de API Adicionar e-mails para verificação para verificar esse endereço de e-mail (1 crédito por endereço de e-mail) e, em seguida, repetir a chamada de API Verificador de e-mails (grátis) para ver os resultados da verificação.
Chamadas de API da Snov.io
Todas as chamadas de API da Snov.io funcionam de forma parecida: você insere a URL, os parâmetros de entrada e o token de acesso para receber uma resposta:
- Pesquisa de domínios V.2
- Contagem de e-mails
- Localizador de e-mails
- Adicionar nomes para localizar e-mails
- Adicionar URL para buscar clientes potenciais
- Obter cliente potencial com URL
- Obter perfil com e-mail
Ou ative uma determinada ação, como uma das seguintes:
- Adicionar cliente potencial à lista
- Localizar cliente potencial por ID
- Localizar cliente potencial por e-mail
- Encontrar os campos personalizados do cliente potencial
- Ver listas do usuário
- Ver clientes potenciais na lista
- Criar nova lista de clientes potenciais
Limites de API da Snov.io
A API da Snov.io tem algumas limitações quanto ao número de chamadas que você pode fazer por hora e por minuto.
Há um limite de 60 chamadas de API por minuto.
Os limites por hora dependem do seu plano:
Limites de chamada de API do Localizador de e-mails:
- Starter: 200 solicitações/hora
- Pro 5K: 400 solicitações/hora
- Pro 20K: 600 solicitações/hora
- Pro 50K: 800 solicitações/hora
- Pro 100K: 1.000 solicitações/hora
Limites de chamada de API do Verificador de e-mails:
- Starter: 500 solicitações/hora
- Pro 5K: 1.000 solicitações/hora
- Pro 20K: 1.400 solicitações/hora
- Pro 50K: 2.000 solicitações/hora
- Pro 100K: 4.000 solicitações/hora
Você pode consultar uma lista completa de chamadas de API disponíveis, seus parâmetros, custo em créditos e limites em nossa Documentação da API.
Não tem seu próprio aplicativo para conectar com a API do Snov.io, mas deseja integrar seus aplicativos favoritos? Saiba como usar a integração com o Zapier.
Precisa de acesso à API da Snov.io? Fique à vontade para entrar em contato com nossos representantes para agendar uma sessão de teste.
Sinto por isso
Como podemos melhorar?