A Store API pública por créditos está em fase final de preparação e ainda não está no ar.
Esta página antecipa o formato das chaves, a tabela de custos por chamada, as franquias mensais dos planos e os pacotes avulsos via PIX.
Store API por Créditos: Catálogo e Ofertas
Consulte árvores de categorias, ofertas do dia, mais vendidos e buscas paginadas de produtos com dados normalizados, reserva atômica de créditos e proteção de taxa por conta.
1. Autenticação e Formato da Chave
Cada requisição à Store API utiliza uma chave dedicada enviada no cabeçalho Authorization. O segredo completo é exibido apenas uma única vez no momento da criação no painel; o servidor armazena somente o prefixo de 8 caracteres e o hash HMAC.
GET /v1/store-api/products/search?q=notebook+gamer&page=1 HTTP/1.1 Host: api.goatlinks.com.br Authorization: Bearer goat_live_<prefixo>_<segredo>
Padrão da chave: goat_live_<prefixo 8 [a-z0-9]>_<segredo 40 base62> (até 5 chaves ativas por usuário).
2. Custo em Créditos por Operação
O débito segue o fluxo RESERVATION → CONFIRMATION / RELEASE: operações leves de catálogo ou respostas servidas em cache dentro do TTL custam 1 crédito; listagens paginadas ao vivo de até 50 produtos por página custam 5 créditos. Em caso de falha upstream, bloqueio, timeout ou rate limit, a reserva é liberada e o custo é 0 créditos.
| Operação | Endpoint | Descrição | Ao vivo | Em cache |
|---|---|---|---|---|
| categories.tree | GET /v1/store-api/categories/tree | Árvore completa de categorias e nichos suportados pela loja. | 1 crédito | 1 crédito |
| categories.get | GET /v1/store-api/categories/:id | Metadados e subcategorias de uma categoria específica. | 1 crédito | 1 crédito |
| categories.discover | GET /v1/store-api/categories/discover | Descoberta rápida de categorias a partir de um termo ou campanha. | 1 crédito | 1 crédito |
| stores.search | GET /v1/store-api/stores/search | Busca de lojas oficiais e anunciantes mapeados. | 1 crédito | 1 crédito |
| products.search | GET /v1/store-api/products/search | Busca paginada ao vivo por palavras-chave (até 50 produtos por página). | 5 créditos | 1 crédito |
| categories.products | GET /v1/store-api/categories/:id/products | Listagem paginada ao vivo de ofertas de uma categoria (até 50 produtos). | 5 créditos | 1 crédito |
| deals.list | GET /v1/store-api/deals | Vitrine paginada ao vivo de ofertas do dia e quedas de preço (até 50 produtos). | 5 créditos | 1 crédito |
| categories.best-sellers | GET /v1/store-api/categories/:id/best-sellers | Mais vendidos da categoria ao vivo (até 50 produtos por página). | 5 créditos | 1 crédito |
3. Limites de Requisições (RPM) e Franquia Mensal por Plano
Todo plano ativo recebe automaticamente uma franquia mensal de créditos na ativação ou renovação do ciclo, com controle de taxa por minuto (RPM) e concorrência no Redis antes de acionar o banco ou a loja:
Franquia inclusa: 1.000 créditos / mês
Concorrência: 1 requisição simultânea
Franquia inclusa: 5.000 créditos / mês
Concorrência: 2 requisições simultâneas
Franquia inclusa: 20.000 créditos / mês
Concorrência: 4 requisições simultâneas
4. Pacotes Avulsos de Créditos (Recarga via PIX)
Precisa de mais volume de busca além da franquia mensal do seu plano? Você poderá adquirir pacotes avulsos via PIX direto no painel:
5.000 créditos
Até 1.000 páginas ao vivo (≈ 50.000 produtos)
25.000 créditos
Até 5.000 páginas ao vivo (≈ 250.000 produtos)
100.000 créditos
Até 20.000 páginas ao vivo (≈ 1.000.000 produtos)
5. Cabeçalhos de Transparência em Cada Resposta
Todas as respostas incluem cabeçalhos HTTP de rate limit (X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, Retry-After) e de consumo de créditos (X-Credits-Charged e X-Credits-Remaining).