Seção 8 de 12

Integrações e API

Integre o Buqq com seu POS ou ferramentas personalizadas via a API REST externa.

A seção de Integrações fornece uma API REST externa para criar integrações personalizadas com seu POS ou outras ferramentas. Acesse-a em Painel → Integrações.

A referência completa da API — esquemas de endpoints, detalhes de autenticação e exemplos — está disponível em buqq.online/api-docs.
Os alertas de reserva por Telegram são configurados em Configurações → Notificações. Consulte a seção Configuraçõesdeste guia para os passos de configuração.

ID do Comerciante#

Seu ID de Comerciante é um identificador único da sua conta na plataforma Buqq. Ele é exibido na página de Integrações e é necessário ao entrar em contato com o suporte ou ao utilizar determinados endpoints da API.

Chaves de API#

A API externa do Buqq permite consultar disponibilidade, criar reservas e atualizar status de reservas a partir dos seus próprios sistemas. O acesso à API requer uma chave de API associada à sua conta de comerciante.

Gerando uma chave

  1. Em Painel → Integrações, role até "Chaves de API".
  2. Clique em "Gerar chave de API".
  3. Copie a chave e armazene-a nas suas variáveis de ambiente ou gerenciador de segredos.
Trate sua chave de API como uma senha — não a compartilhe nem a inclua no controle de versão. Se você suspeitar que uma chave foi comprometida, revogue-a imediatamente e gere uma nova.

Revelando a chave atual

Se precisar recuperar sua chave existente, clique em Revelar— a chave completa é exibida para que você possa copiá-la novamente.

Rotacionando uma chave

Rotacionar substitui sua chave atual por uma nova. A chave antiga é invalidada imediatamente. Atualize quaisquer integrações que usam a chave antiga antes de rotacionar.

Revogando uma chave

Revogar exclui a chave atual sem emitir uma nova. As chamadas de API falharão até que você gere uma nova chave. Use revogar se suspeitar que uma chave foi comprometida.

Exemplos cURL#

A página de Integrações exibe exemplos cURL prontos para uso para as operações de API mais comuns. Substitua YOUR_API_KEY pela sua chave real para testar imediatamente.

EXEMPLO — Verificar disponibilidade

curl https://buqq.online/api/external/v1/availability \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -G -d "date=2025-08-15" -d "party_size=2"

Notas sobre POS#

Se você está conectando o Buqq a um sistema de ponto de venda, a API externa suporta a leitura das reservas confirmadas do dia e a atualização de status (ex.: marcar uma reserva como check-in realizado ou cancelada) a partir do seu POS. Consulte a documentação do seu fornecedor de POS para os passos específicos de integração, e consulte a documentação da API para detalhes dos endpoints.

GET /api/external/v1/availability
Retorna os horários disponíveis para uma data e tamanho de grupo específicos.
GET /api/external/v1/bookings
Lista as reservas do seu restaurante. Filtre por data.
POST /api/external/v1/bookings
Cria uma nova reserva programaticamente.
PATCH /api/external/v1/bookings/{id}/status
Atualiza o status de uma reserva (confirmed, checked_in, cancelled, no_show).