Teste grátis por 07 dias · crie sua conta e comece agora mesmo, sem incluir dados do cartão de crédito · sem cartão de crédito
Início
Soluções
Segmentos
Planos e Preços
Equipamentos
Seja parceiro
Falar agora
API de integração

Uma API completa para quem desenvolve

Dá para integrar praticamente tudo do sistema: produtos, pedidos, mesas e garçom, financeiro, descontos, chat, fiscal e controle de loja. Serve tanto para conectar o seu software à Gama quanto para desenvolver soluções plugadas nela.

Pedido com geolocalização Status de pronto e cancelado Abertura e fechamento de loja Exportação de produtos e usuários
Vitor Gama, CEO da Gama Delivery Vitor Gama CEO da Gama Delivery

Para que serve a API

Deixa eu te explicar sem termo técnico. A API da Gama abre praticamente o sistema inteiro para quem desenvolve: produto, pedido, mesa, garçom, financeiro, desconto, chat, fiscal. Serve para duas coisas. Conectar o software que a loja já usa, para ninguém digitar a mesma informação duas vezes. E construir solução nova plugada na Gama, usando a operação que já roda ali como base.

O que dá para fazer

O que dá para alcançar pela API.

São as áreas do sistema que a integração alcança. A referência de cada endpoint, com exemplo de requisição e resposta, fica na documentação.

Produtos e cardápio

Ler e manter o catálogo da loja pelo seu sistema, em vez de cadastrar a mesma coisa em dois lugares.

Criar pedidos

O pedido nasce no seu sistema e cai direto na operação, com geolocalização (coordenadas) para a entrega.

Marcar pedido como pronto

Atualizar o status quando a produção termina, mantendo a loja e o seu sistema sincronizados.

Cancelar pedido

Registrar o cancelamento pelo mesmo canal, para os dois lados não ficarem com informação divergente.

Mesas e garçom

Alcançar a operação de salão pelo mesmo canal, para quem monta comanda ou atendimento próprio.

Financeiro

Levar movimento e fechamento para o seu ERP, BI ou sistema contábil sem exportar planilha à mão.

Cupons e descontos

Aplicar regra de desconto a partir do seu sistema, útil para quem já roda a própria campanha.

Chat e atendimento

Plugar o seu robô, CRM ou canal de atendimento à conversa que já acontece na operação.

Fiscal

Chegar à camada fiscal da operação pelo mesmo canal da integração.

Abrir e fechar a loja

Controlar a disponibilidade remotamente, útil para quem centraliza a gestão de várias unidades.

Exportar dados

Obter produtos, usuários e demais informações da operação para alimentar o seu sistema, BI ou ERP.

Acompanhar disponibilidade

A API tem página pública de status, o que ajuda a monitorar a integração em produção.

Ficha técnica

O que o seu desenvolvedor precisa saber antes de começar.

Finalidade Integrar sistemas de terceiros ao Gama Delivery
URL base https://ambiente.delivery.app/api/{função}
Formato da resposta Campos errors, data e body em toda resposta
Limite de requisições 5 por segundo, por endpoint (excedeu, retorna 429)
Status da API Página pública de disponibilidade
Homologação Validação assistida antes de ir para produção
Para quem serve

Quem costuma integrar com a Gama.

ERP

ERP e retaguarda

Empresas que já rodam um ERP e querem que o pedido nasça ou termine nele, sem digitação dupla entre os dois sistemas.

Agregadores

Marketplaces e agregadores

Plataformas de pedido que precisam despachar o pedido direto para a operação da loja, com endereço e coordenadas.

Redes

Franquias e redes

Operações com várias unidades que centralizam abertura, fechamento e acompanhamento a partir de um painel próprio.

Automação

Bots e canais próprios

Quem construiu o próprio robô de atendimento, totem ou aplicativo e precisa que o pedido caia na operação real.

Como entrar em produção

Do primeiro contato à integração no ar.

A homologação é assistida: em vez de liberar acesso e torcer, o time valida junto com você antes de a integração atender cliente real.

01

Fale com o time técnico

O primeiro contato define o cenário da integração: o que o seu sistema precisa enviar, o que precisa receber e em qual volume.

02

Desenvolva contra a documentação

A referência completa dos endpoints, com exemplos de requisição e resposta, fica publicada no Postman e é o material de trabalho do seu desenvolvedor.

03

Agende a homologação

Terminado o desenvolvimento, avise o time. Uma reunião é marcada para validar a integração em conjunto.

04

Valide os pontos obrigatórios

Na chamada são verificados: comunicação estável, geração de pedido com coordenadas, marcação de pronto e de cancelado, abertura e fechamento de loja e exportação de dados.

05

Suba para produção

Com os pontos validados, a integração é liberada e passa a operar com o acompanhamento do time.

Perguntas frequentes

Dúvidas técnicas mais comuns.

O que dá para fazer com a API da Gama?
Praticamente tudo o que a operação faz: produtos e cardápio, pedidos (criar, marcar como pronto, cancelar), mesas e garçom, financeiro, cupons e descontos, chat, fiscal, abertura e fechamento de loja e exportação de dados. Dá tanto para conectar um software que a loja já usa quanto para desenvolver uma solução nova plugada na Gama. A referência completa dos endpoints está na documentação publicada no Postman.
Existe limite de requisições?
Sim. O limite é de 5 requisições por segundo para qualquer endpoint. Acima disso, a API pode responder com status 429, então vale prever controle de fila e repetição no seu lado.
Como é o formato das respostas?
Toda resposta traz um indicador de erros, o campo com o resultado e um campo adicional com mais detalhes sobre o retorno. Também é importante tratar o status code HTTP de cada requisição.
Preciso passar por homologação?
Sim. Depois de desenvolver, o time agenda uma reunião de homologação para validar em conjunto a estabilidade da comunicação e as operações principais antes da liberação em produção.
A geolocalização é obrigatória no pedido?
O envio de pedido com coordenadas é um dos pontos validados na homologação, o que indica que a geolocalização é parte esperada da integração para entrega. Confirme os campos obrigatórios na documentação e com o time técnico.
Como acompanho se a API está no ar?
Existe uma página pública de status da API, útil para monitorar disponibilidade e diferenciar um problema da integração de uma indisponibilidade momentânea.
Preciso da API se o que eu quero é ter a minha marca no cardápio e no app?
Nesse caso costuma sair mais barato o modelo white label, que entrega cardápio, site e aplicativo prontos com a sua identidade. A API faz sentido quando você vai desenvolver de verdade: integrar um software próprio ou construir algo novo em cima da operação.

Vai integrar com a Gama?

Conte o cenário da sua integração, o que o seu sistema precisa enviar e receber e em qual volume, e o time técnico orienta o caminho até a homologação.

Documentação completa publicada no Postman
Homologação assistida antes da produção
Página pública de status da API

Falar com o time técnico

Preencha e descreva o cenário. O retorno vem com os próximos passos da integração.

Seus dados são usados apenas para o contato técnico da Gama.

Ver documentação WhatsApp