Início rápido

Antes de começar

• Uma conta Watch-IP — o plano gratuito é suficiente para seguir este guia.
• Uma página ou script ao qual possa adicionar uma chamada fetch ou curl.

1. Crie uma conta e obtenha uma chave

Registe-se e abra o seu painel. Todas as contas começam com uma chave publicável de visitante — configure as suas origens permitidas para incluir o site a partir do qual a vai chamar (ou localhost durante os testes).

2. Faça o seu primeiro pedido

Chame GET /v1/geo com a sua chave publicável no cabeçalho X-Api-Key. A partir de um navegador, isto resolve a própria ligação do visitante; a partir de um servidor, resolve antes a própria ligação do servidor.

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

3. Leia a resposta

Um pedido bem-sucedido devolve 200 com um corpo JSON — country, city e timezone são os campos com que a maioria das integrações começa, e cada campo pode ser nulo de forma independente, por isso verifique antes de o utilizar.

{
  "ip": "203.0.113.1",
  "country": "US",
  "city": "Austin",
  "timezone": "America/Chicago"
}

4. Pesquise um IP diferente

Precisa de resolver um endereço que já tem, em vez do visitante em ligação? Isso é um endpoint servidor-a-servidor separado, autenticado com uma chave secreta, não com a sua chave publicável — consulte a referência de pesquisa de IP.

Se algo correr mal

Um 401 significa que a chave de API está em falta ou é inválida; um 403 de GET /v1/geo normalmente significa que a origem que está a chamar ainda não consta da lista de origens permitidas da chave. Consulte erros e limites de taxa para a lista completa de códigos de estado.

Próximo passo

Leia sobre autenticação para saber como funcionam os tipos de chave e o bloqueio por origem, ou vá diretamente para a referência de endpoints para a resposta com a qual está a integrar.