Visão geral
A sua loja tem uma API pública: um endereço na internet que devolve os dados do seu acervo e da sua loja em formato JSON, prontos para outros programas lerem. Serve para você integrar os dados da sua loja com o seu próprio site, uma planilha, uma ferramenta de BI (relatórios) ou um aplicativo — sem precisar copiar os dados da vitrine manualmente.
A API é somente leitura: ela apenas devolve informações, nunca altera nada na sua loja. E ela mostra os mesmos dados que já aparecem publicamente na sua vitrine — catálogo de jogos e dados de contato da loja.
O endereço da sua loja
O endereço base usa o subdomínio da sua loja. Troque SUA-LOJA pelo subdomínio
que você já usa na vitrine (por exemplo, se a sua loja é ludoteca.acervodejogos.com.br,
o subdomínio é ludoteca):
https://SUA-LOJA.acervodejogos.com.br/api/v1/...Não precisa de senha nem de login. Como são os mesmos dados que já estão à vista na vitrine, basta abrir o endereço.
Os três endereços disponíveis
A API tem três endereços (endpoints). Cada um devolve uma lista de dados diferente:
-
/api/v1/boardgames— o catálogo completo de jogos, com todos os detalhes de cada jogo. -
/api/v1/copies— uma lista mais enxuta das cópias (estoque), com o essencial de cada jogo. -
/api/v1/company— os dados públicos da loja (contato, endereço e redes sociais).
Catálogo de jogos (boardgames)
O endereço /api/v1/boardgames devolve o catálogo completo. Cada jogo traz:
- id, slug e bgg_id — identificadores do jogo (o
bgg_idé o código do BoardGameGeek). - name — o nome do jogo.
- rentable — se o jogo pode ser alugado (verdadeiro ou falso).
- category e category_id — a categoria do jogo e o seu identificador.
- price e days — o preço e a quantidade de dias do aluguel padrão.
- price_variants — a lista de variações de preço, cada uma com
priceedays. - status — a situação do jogo (por exemplo, disponível ou alugado).
- copy — a cópia física do jogo.
- description — a descrição do jogo.
- tags — as etiquetas do jogo.
- min_players, max_players, minimum_age e playing_time — número de jogadores, idade mínima e duração.
- bayesian_average e average_rating — as notas do BoardGameGeek.
- youtube_links — os vídeos ligados ao jogo.
- publisher — a editora do jogo.
Cópias / estoque (copies)
O endereço /api/v1/copies é uma versão mais enxuta, focada no estoque. Cada item traz:
id, slug, bgg_id, name,
rentable, price, days,
price_variants, status e copy.
Dados da loja (company)
O endereço /api/v1/company devolve os dados públicos da sua loja:
name_for_title (nome de exibição), phone,
whatsapp, complete_company_name (nome completo),
address (endereço), site, email,
facebook_link, twitter_link, instagram_link,
sobre_nos (texto do "Sobre nós") e google_maps_link.
Como testar agora
A forma mais rápida de conferir é abrir o endereço direto no navegador. Troque SUA-LOJA pelo subdomínio da sua loja e acesse:
https://SUA-LOJA.acervodejogos.com.br/api/v1/boardgames
O navegador vai mostrar a lista de jogos em JSON. Para usar em uma ferramenta ou script, um
exemplo com curl no terminal:
curl https://SUA-LOJA.acervodejogos.com.br/api/v1/boardgames
Os endereços /api/v1/copies e /api/v1/company funcionam da mesma forma:
basta trocar o final do endereço.
É público
Como não pede senha, qualquer pessoa com o endereço consegue ler esses dados. Isso é esperado: são as mesmas informações que já estão visíveis na sua vitrine.
Se a sua loja estiver desativada, a API também fica indisponível — exatamente como a vitrine.