Pular para o conteúdo

Capzy Data API. Escolha sua fonte.

Encontre o endpoint de um site suportado, envie seus parâmetros e receba JSON. Explore a referência aqui e depois execute e examine requisições no playground do seu painel.

Busca na Amazon, em resumo

Fonte + açãoGET /v1/amazon/search
Consultawireless earbuds
Campo da respostaorganic_results · títulos, preços, ASINs

Exemplo ilustrativo

Encontre a fonte de que você precisa

Cada fonte tem seus próprios endpoints, entradas obrigatórias e formato de resposta. Abra a referência dela para verificar a cobertura antes de construir uma integração.

Todas as fontes (83)

Sua primeira requisição na Data API

Este exemplo da Amazon usa um endpoint GET específico da fonte. HTTP 200 retorna os dados da fonte; HTTP 202 retorna um status pendente e um jobId. Examine os jobs pendentes na página Runs do painel da Data API antes de enviar outra requisição.

  1. Crie uma chave da Data API

    Abra o painel da Data API para copiar sua chave dedicada da Data API. Os créditos do plano são usados primeiro; o uso adicional é cobrado do saldo compartilhado da sua conta Capzy.

    Abrir Data API
  2. Escolha a fonte e a ação

    Use a referência do site para encontrar o método, o caminho e os parâmetros obrigatórios. O exemplo de busca da Amazon envia query e domain para /v1/amazon/search.

    Ler os parâmetros de busca da Amazon
  3. Examine o JSON no playground

    Abra a fonte correspondente no seu painel, selecione a ação, preencha as entradas e execute uma requisição. Confira o preço atual do endpoint antes de executar.

    Abrir o playground de busca da Amazon
amazon_search.py
# Install: pip install requests
import os
import requests

response = requests.get(
    "https://api.capzy.ai/v1/amazon/search",
    headers={"X-API-Key": os.environ["CAPZY_DATA_API_KEY"]},
    params={"query": "wireless earbuds", "domain": "com"},
    timeout=120,
)
response.raise_for_status()
data = response.json()
if response.status_code == 202:
    print("Pending:", data.get("status"), "Job:", data.get("jobId"))
    print("Inspect this job in https://capzy.ai/dashboard/data-api/runs")
else:
    for item in data.get("organic_results", []):
        print(item["title"], item.get("price"))
    print("Credits used:", response.headers.get("X-Credits-Used"))

Conheça o contrato antes de chamar

A autenticação é compartilhada entre as fontes da Data API. Métodos, parâmetros e campos retornados pertencem a cada endpoint.

X-API-KeyObrigatório · header
Envie sua chave dedicada da Data API neste header. Mantenha-a no servidor e leia-a de CAPZY_DATA_API_KEY nestes exemplos.
/v1/{source}/{path}Específico do endpoint · caminho
Siga o método e o caminho indicados na referência da fonte. Por exemplo, GET /v1/amazon/search recebe query e domain como parâmetros de consulta.
X-Credits-UsedHeader da resposta
Confira os créditos cobrados pela requisição. Os preços dos endpoints e os descontos dos planos são exibidos no painel e na referência da fonte.
X-Next-CursorHeader da resposta · quando presente
Alguns endpoints retornam um cursor para a próxima página. Use os parâmetros de paginação de cada endpoint; nem toda fonte usa o mesmo modelo de paginação.

Use os campos reais da resposta da fonte

Uma resposta HTTP 200 da busca da Amazon expõe organic_results no nível superior. Já HTTP 202 retorna um envelope de status com jobId; examine-o na página Runs do painel. Esta resposta bem-sucedida resumida usa dados de produtos ilustrativos.

response.example.json
{
  "search_information": {
    "query": "wireless earbuds"
  },
  "organic_results": [
    {
      "title": "Example wireless earbuds",
      "price": "$27.99",
      "extracted_price": 27.99,
      "asin": "EXAMPLE001"
    }
  ]
}

organic_results · títulos, preços, ASINs

Parâmetros

Preços

Os planos da Data API incluem uma cota mensal de créditos. O uso extra é cobrado do saldo compartilhado da sua conta Capzy. Confira a referência da fonte para ver o preço atual em créditos do endpoint.

Carregando preços atuais…

Algumas coisas para saber

Onde o playground abre?

Em Painel → Data API → Scrapers. Os links de fontes abrem o construtor daquela fonte. Os links de endpoints pré-selecionam a ação correspondente, para que você possa examinar as entradas obrigatórias antes de executar.

Posso usar minha chave de API do solucionador?

Use a chave dedicada da Data API exibida no painel da Data API. A Data API tem seus próprios controles de plano e créditos incluídos, enquanto o uso extra é financiado pelo saldo compartilhado da sua conta Capzy.

Todas as fontes retornam o mesmo JSON?

Não. Cada endpoint tem um formato de resposta específico da fonte. Examine a resposta documentada e trate campos ausentes ou opcionais na sua aplicação.

E se um endpoint estiver marcado como em breve?

O painel marca os endpoints que não estão verificados ou disponíveis para execução. Use as ações suportadas exibidas ali; uma entrada na referência, por si só, não garante que um endpoint esteja pronto.

Encontre uma fonte. Teste uma requisição real.

O playground do painel reúne as entradas, a resposta e os preços atuais.

Abrir playground