Watch-IP

Autenticação

O Watch-IP utiliza dois tipos de chave, consoante o endpoint que está a chamar — uma chave publicável segura para o navegador, para chamadas do lado do cliente, e uma chave secreta apenas para o servidor, para chamadas de back-end. Enviar o tipo errado devolve 401 ou 403, nunca uma resposta parcial.

Chaves publicáveis (seguras para o navegador)

Utilizadas para GET /v1/geo e POST /v1/email/validate — ambos concebidos para serem chamados diretamente a partir do navegador de um visitante. Envie-a no cabeçalho X-Api-Key (GET /v1/geo também aceita um parâmetro de consulta key como alternativa). Não é secreta: é distribuída no JavaScript da sua página, e o controlo que importa é a lista de origens permitidas configurada para a chave, verificada em função do cabeçalho Origin/Referer do pedido. Um pedido de uma origem que não conste dessa lista recebe um 403 sem qualquer cabeçalho CORS definido — o navegador bloqueia a resposta antes de o seu código sequer a ver, o que é a verdadeira aplicação, não o corpo de erro JSON.

Chave publicável

curl https://api.watch-ip.com/v1/geo \
  -H "X-Api-Key: YOUR_PUBLISHABLE_KEY"

Chaves secretas (apenas para o servidor)

Utilizadas para GET /v1/lookup/{ip}, POST /v1/lookup, e POST /v1/risk/check — todos endpoints servidor-a-servidor, sem qualquer Origin de navegador para verificar. Envie-a como Authorization: Bearer YOUR_SECRET_KEY apenas a partir do seu próprio back-end; nunca incorpore uma chave secreta numa página, num pacote de aplicação móvel, ou em qualquer cliente que não controle. Utilizar uma chave publicável numa rota de chave secreta, ou uma chave secreta numa rota de chave publicável, devolve 403.

Chave secreta

curl https://api.watch-ip.com/v1/lookup/203.0.113.1 \
  -H "Authorization: Bearer YOUR_SECRET_KEY"

Limitação de taxa

Todas as chaves têm um limite de taxa por conta de cliente numa janela fixa de um minuto, partilhado entre todos os endpoints que chamar, em vez de ser controlado por rota. Excedê-lo devolve 429 — consulte erros e limites de taxa para a forma da resposta e como recuar. O limite de taxa por minuto conta chamadas HTTP, não itens: um lote de até 100 IP ou endereços de e-mail conta como um único pedido, enquanto cada item continua a contar separadamente para o limite mensal de pedidos.

Domínios personalizados

Os planos Growth e Scale incluem um percurso de configuração de domínio personalizado no painel, para que os pedidos possam ser dirigidos a um nome de anfitrião no seu próprio domínio, em vez de api.watch-ip.com. A disponibilidade depende da elegibilidade da conta e da configuração bem-sucedida de DNS/SSL — aponte a sua integração para o URL base que o seu painel confirmar estar ativo.

Páginas relacionadas