Docs

Primeiros passos

Do cadastro aos primeiros dados ao vivo em poucos minutos. Você envia um endereço da web ou um termo de busca junto com sua chave de API e recebe os dados em JSON. Depois, uma olhada rápida em erros, limites e cache.

Três passos

1
Crie sua conta
Informe seu e-mail, confirme pelo link que enviamos e defina uma senha. Cadastre-se grátis
2
Copie sua chave de API
Na sua primeira visita, o painel cria uma chave chamada “default” e a mostra uma única vez. Copie-a e guarde-a em local seguro.
3
Faça sua primeira requisição
Clique em Testar no início rápido do painel ou execute a requisição abaixo com sua chave.

Sua chave de API

Envie sua chave em toda requisição no header x-api-key. As chaves começam com ds_. Guardamos apenas uma impressão digital de cada chave, por isso ela só é exibida por completo uma vez, na criação. Guarde-a em um gerenciador de segredos, nunca em código que roda no navegador. Você pode criar mais chaves e revogar as antigas em Chaves de API.

x-api-key: ds_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

URL base: https://api.everydata.io.

Sua primeira requisição

Pesquise “wireless headphones” na Amazon. É a mesma requisição do botão Testar no painel, onde sua chave já vem preenchida logo após ser criada. withCache=true permite uma resposta de até 10 minutos atrás, o que a torna rápida.

GET /amz/amazon-search-by-keyword-asin

curl "https://api.everydata.io/amz/amazon-search-by-keyword-asin?domainCode=com&keyword=wireless+headphones&page=1&withCache=true" \
  -H "x-api-key: YOUR_API_KEY"

O que você recebe

Toda resposta bem-sucedida é um JSON que começa com os mesmos dois campos, responseStatus e responseMessage, seguidos dos dados do endpoint. Páginas de resultados acrescentam currentPage, nextPage e lastPage.

200 OK

{
  "responseStatus": "PRODUCT_FOUND_RESPONSE",
  "responseMessage": "Product successfully found!",
  "domainCode": "com",
  "keyword": "wireless headphones",
  "foundProducts": [
    "…"
  ],
  "searchProductDetails": [
    "…"
  ]
}

Erros

Erros retornam um pequeno corpo JSON com o status HTTP e uma mensagem legível. Só respostas bem-sucedidas e 404 (um “não encontrado” válido) contam na sua cota.

400 Bad Request

{
  "statusCode": 400,
  "statusMessage": "Bad Request - Missing or invalid parameter: keyword: Field required"
}

HTTP	Significado	Contabilizado
200	Sucesso. Os dados vêm depois de responseStatus e responseMessage.	Sim
400	Um parâmetro obrigatório está faltando ou tem o formato errado.	Não
401	A chave de API está faltando, está errada ou foi revogada.	Não
403	Sua cota mensal (ou o limite de uso justo) se esgotou.	Não
404	A página foi carregada, mas não há produto ou anúncio para o que você informou.	Sim
429	Requisições demais por minuto. A mensagem informa quantos segundos esperar.	Não
502	O site bloqueou esta tentativa. Tente novamente.	Não
503	Não foi possível carregar o site. Tente novamente.	Não

Limites e cota

Dois limites valem por conta: requisições por minuto (de 10 a 750, conforme o plano) e requisições por mês. Ambos são compartilhados por todas as plataformas e todas as chaves da sua conta. Requisições demais por minuto retornam 429; quando a cota mensal se esgota, você recebe 403 até ela ser renovada no início do próximo período de cobrança.

Requisições que falham porque um site não pôde ser carregado (5xx) não são contabilizadas. Seu uso atual está na página de uso; a página de preços lista os limites de cada plano.

Cache

As respostas são ao vivo por padrão. Quando a velocidade importa mais que a atualidade, vários endpoints aceitam withCache=true ou cacheTtl (segundos) e podem responder a partir de uma cópia recente. Uma resposta em cache também conta como uma requisição.

Próximo passo: navegue pela referência da API completa.