API para Desenvolvedores

Integre a gastroGo com seus sistemas e crie soluções personalizadas.

Status da API

Operacional

99.9% uptime

Chaves de API

Gerencie no painel

Documentação

Completa e atualizada

Ver seções

Visão Geral

A API da gastroGo permite que você integre funcionalidades da plataforma diretamente nos seus sistemas. Com ela, é possível:

  • Consultar e criar reservas
  • Gerenciar clientes e pontos goDots
  • Acessar relatórios e métricas
  • Integrar com PDV e sistemas de entrega
  • Automatizar campanhas de marketing

Nossa API é RESTful, utiliza autenticação via Bearer Token e retorna respostas em JSON. Todas as requisições devem ser feitas via HTTPS.

Autenticação

Para acessar a API, você precisa de uma chave de API (API Key) gerada no painel do parceiro. Envie a chave no header das requisições:

Authorization: Bearer SUA_CHAVE_API

Todas as requisições devem incluir este header. As chaves são vinculadas a um restaurante específico e possuem permissões definidas no momento da criação.

Endpoints Principais

GET /api/v1/reservas

Lista todas as reservas do restaurante, com filtros por data, status e cliente.

Exemplo de resposta:

{
  "reservas": [
    {
      "id": "res_123",
      "cliente": "João Silva",
      "data": "2025-03-10",
      "horario": "20:00",
      "pessoas": 4,
      "status": "confirmada"
    }
  ],
  "total": 25
}
GET /api/v1/clientes

Retorna a lista de clientes cadastrados, com histórico de visitas e pontos goDots.

POST /api/v1/reservas

Cria uma nova reserva. É necessário enviar os dados no corpo da requisição.

Exemplo de corpo (JSON):

{
  "cliente_id": "cli_456",
  "data": "2025-03-15",
  "horario": "19:30",
  "pessoas": 2,
  "observacoes": "Mesa perto da janela"
}

SDK JavaScript

Integre facilmente com aplicações web usando nosso pacote NPM.

npm install @gastrogo/sdk

SDK Python

Para backends em Django, Flask ou FastAPI.

pip install gastrogo-sdk

Documentação Completa

Acesse nossa documentação interativa com todos os endpoints, parâmetros e exemplos.

Documentação Interativa (Swagger) Download PDF

Suporte para Desenvolvedores

Tem dúvidas técnicas? Nossa equipe de desenvolvedores está pronta para ajudar.

Horário de atendimento: 9h às 18h (dias úteis)