Referência pública

API Tabela SIPE

Catálogo normalizado de eletrônicos: marca, modelo, armazenamento, memória, cor, processador e identificadores de fábrica. Respostas em JSON, autenticação por chave.

Autenticação

Toda chamada exige uma chave gerada no seu painel, no formato sipe_live_… (ou sipe_test_… em sandbox). Envie no cabeçalho x-api-key — ou, se preferir o padrão OAuth, em Authorization: Bearer. A chave nunca deve ser usada no navegador do usuário final, só no seu servidor.

curl "https://sipe.quollapp.com/api/public/v1/aparelhos?marca=Samsung&modelo=Galaxy S25 Ultra" \
  -H "x-api-key: sipe_live_sua_chave"

# equivalente, com Bearer:
curl "https://sipe.quollapp.com/api/public/v1/aparelhos?marca=Samsung&modelo=Galaxy S25 Ultra" \
  -H "Authorization: Bearer sipe_live_sua_chave"

Limites de uso

Contas novas começam com 10 consultas gratuitas para teste. Depois disso a chave fica bloqueada até a contratação de um plano ou recarga de créditos. Cada chamada bem sucedida consome uma consulta. Toda resposta autenticada traz o saldo atual nos cabeçalhos — não é preciso consultar o painel pra saber quanto resta:

X-Sipe-Quota-Limitheader

Consultas incluídas no plano ou na avaliação gratuita.

X-Sipe-Quota-Usedheader

Quantas dessas consultas incluídas já foram usadas no ciclo atual.

X-Sipe-Quota-Remainingheader

Consultas restantes, somando o que falta do ciclo com o saldo de créditos comprado.

X-Sipe-Creditsheader

Saldo de créditos comprado em recarga, que não expira no fim do ciclo.

Consulta agrupada

GET /aparelhos

Devolve uma linha por aparelho, com as opções resumidas em listas. Ideal para preencher seletores de armazenamento, memória e cor.

modelotexto · obrigatório

Nome ou parte do nome do aparelho.

marcatexto

Restringe a busca a uma marca. Recomendado para reduzir ambiguidade.

limitenúmero

Quantidade máxima de aparelhos na resposta (padrão 10, máximo 50).

Exemplo real, aparelho do catálogo (a foto ainda não está disponível pra este modelo — image_url vem null até o catálogo ganhar imagens):

{
  "query": { "brand": "Samsung", "model": "Galaxy S25 Ultra" },
  "count": 1,
  "data": [{
    "device_id": "b956309a-3fb6-4f93-b496-8d8a5096b7ae",
    "device": "Samsung Galaxy S25 Ultra 5G",
    "brand": "Samsung",
    "category": "Smartphones",
    "storage_options_gb": [256, 512, 1024],
    "ram_options_gb": [12, 16, 18],
    "colors": ["Titanium Jet Black", "Titanium Gray", "Titanium White Silver"],
    "combinations_count": 63,
    "price_excelente_from": 5321,
    "currency": "BRL",
    "price_updated_at": "2026-09-13",
    "released_date": "2025-01-26",
    "announced_date": null,
    "image_url": null,
    "brand_logo_url": null
  }]
}

price_excelente_from é o preço da configuração de entrada do aparelho, em estado excelente. O valor já vem calculado e gravado — a consulta apenas lê, nunca calcula na hora, então o tempo de resposta não depende do modelo consultado. price_updated_at diz de quando é esse cálculo. Aparelho ainda sem preço apurado devolve os três campos como null.

Consulta detalhada

GET /aparelhos/detalhado

Devolve uma linha por combinação de armazenamento, memória e cor. Os filtros são opcionais e cumulativos: sem informar o armazenamento, você recebe todas as capacidades.

modelotexto · obrigatório

Nome ou parte do nome do aparelho.

marcatexto

Restringe a busca a uma marca.

gbnúmero

Filtra por armazenamento. Omita para receber todas as capacidades.

ramnúmero

Filtra por memória.

cortexto

Filtra por cor de fábrica.

limitenúmero

Quantidade máxima de linhas na resposta (padrão 200, máximo 500).

{
  "query": {
    "brand": "Samsung",
    "model": "Galaxy S25 Ultra",
    "filters": { "storage_gb": 256, "ram_gb": null, "color": null }
  },
  "count": 1,
  "data": [{
    "device_id": "b956309a-3fb6-4f93-b496-8d8a5096b7ae",
    "variant_id": "e25e8189-2652-49a9-ae1a-54ae6763aa89",
    "device": "Samsung Galaxy S25 Ultra 5G",
    "variant": "256 GB · 12 GB RAM · Titanium Jet Black",
    "storage_gb": 256,
    "ram_gb": 12,
    "color": "Titanium Jet Black",
    "cpu": "Qualcomm Snapdragon 8 Elite 5G SM8750-AB (Sun)",
    "model_number": "SM-S938B/DS",
    "price_excelente": 5321,
    "currency": "BRL",
    "price_updated_at": "2026-09-13",
    "released_date": "2025-01-26",
    "image_url": null
  }]
}

Aqui price_excelente é o preço daquela combinação exata, não o da configuração de entrada — é o campo para quem precisa cotar a variante específica que tem em mãos.

Erros

Erros seguem sempre o mesmo formato, com um código estável e uma mensagem legível em português — nunca uma mensagem crua de outro sistema.

{ "error": { "code": "missing_model", "message": "Informe o parâmetro modelo." } }
400 missing_modelrequisição

O parâmetro modelo não foi informado.

401 missing_api_keychave

Nenhuma chave enviada (cabeçalho x-api-key ou Authorization ausente).

401 invalid_api_keychave

Chave inexistente, revogada ou digitada errada.

402 quota_exceededcota

Consultas gratuitas ou do ciclo esgotadas — assine um plano ou faça uma recarga.

403 account_suspendedconta

Conta suspensa. Fale com o suporte.

503 unavailableserviço

Consulta indisponível no momento. Tente novamente.