Saltar para o conteúdo principal
As configurações da API controlam como você acessa a API da Enrow e como ela se comporta em cada requisição. Esta página explica quem pode acessar a API, onde encontrar sua chave de API, como definir uma URL de webhook padrão e como o parâmetro country_code altera o comportamento da busca.

​
Quem pode acessar a API da Enrow?

A API da Enrow está disponível para clientes com uma assinatura ativa ou créditos pré-pagos. Se sua conta não tiver nenhum dos dois, a seção da API não ficará acessível. Para ver como os créditos são consumidos por endpoint, consulte Créditos e cobrança.

​
Onde encontro minha chave de API?

Sua chave de API está no Painel da Enrow — clique em API no menu à esquerda e copie a chave. A mesma chave autentica todos os endpoints através do cabeçalho x-api-key. Para exemplos de requisição e tratamento de erros, consulte Autenticação.
Mantenha sua chave de API segura. Nunca faça commit da chave de API em sistemas de controle de versão nem a compartilhe publicamente. Trate-a como uma senha.

​
Como defino uma URL de webhook padrão?

Você pode configurar uma URL de webhook padrão no painel. Essa URL é usada sempre que nenhum webhook for especificado em uma requisição individual, então você não precisa repeti-la em cada chamada. Um webhook por requisição no objeto settings sempre tem prioridade sobre o padrão do painel. Para formatos de payload, novas tentativas e segurança, consulte Como Funcionam os Webhooks.

​
O que o parâmetro country_code faz?

O parâmetro country_code (ISO 3166-1 alpha-2) define qual versão local do Google a API usa para resolver uma empresa. Passe-o no objeto settings da sua requisição. Se nada for fornecido, o padrão é US.
O código do país só é útil ao pesquisar com company_name (não com company_domain). Ele informa à Enrow qual versão local do Google usar para resolver a empresa — por exemplo, google.de para a Alemanha ou google.fr para a França.
O código do país é particularmente útil para homônimos — empresas que compartilham o mesmo nome em países diferentes: 
// Dove the soap brand (UK)
{
  "company_name": "Dove",
  "fullname": "John Doe",
  "settings": { "country_code": "GB" }
}

// Dove the chocolate brand (Germany)
{
  "company_name": "Dove",
  "fullname": "Hans Müller",
  "settings": { "country_code": "DE" }
}
O objeto settings também aceita webhook (uma URL de webhook por requisição), retrieve_gender (booleano) e retrieve_company_info (booleano). Consulte a referência Find Single Email para a lista completa de configurações disponíveis.

​
FAQ

Não. Uma única chave de API autentica todos os endpoints — Email Finder, Email Verifier e Phone Finder. Passe a chave no cabeçalho x-api-key em cada requisição.
Não. O parâmetro country_code só afeta buscas que usam company_name. Quando você passa um company_domain, o domínio já identifica a empresa, então o código do país não tem efeito.
O webhook por requisição no objeto settings tem prioridade. O padrão do painel só é usado quando uma requisição não inclui sua própria URL de webhook.

​
Próximos passos

Autenticação

Como passar sua chave de API no cabeçalho x-api-key.

Como Funcionam os Webhooks

Configure webhooks para ser notificado quando uma busca for concluída.

Créditos e cobrança

Veja como os créditos são consumidos para cada endpoint.

Encontrar um e-mail

Execute uma única busca de e-mail com configurações personalizadas.