Zenchef API

Introdução

A API da Zenchef permitirá que os restaurantes liguem e distribuam os seus dados a ferramentas de terceiros com as quais a Zenchef não tem atualmente parcerias. Alguns exemplos:

  • Uma agência de marketing que pretenda obter os dados dos clientes do restaurante para lhes enviar mensagens através da sua própria ferramenta de comunicação.
  • Uma empresa de dados que pretenda obter os dados das reservas do restaurante para poder criar painéis de controlo personalizados para o restaurante.

Que subscrição é necessária?

O restaurante deve ter uma subscrição Grow ou deve ter sido celebrado um acordo especial. Se não tiver a certeza de que tem a subscrição correta, pode verificar isso através de https://app.zenchef.com/billing/index. Se não tiver a subscrição correta, contacte o seu gestor de conta ou a nossa equipa de apoio.

Como obter a documentação da API e ter acesso a um restaurante de demonstração?

Se estiver a criar uma integração para um único restaurante ou um grupo de restaurantes

Peça ao restaurante para enviar um pedido de documentação da API Zenchef e, se desejar, um restaurante de demonstração no nosso ambiente de pré-produção para api-tech-help@zenchef.com. Também recomendamos mencionar o restaurantId Zenchef e fornecer mais detalhes sobre o motivo pelo qual desejam utilizar a API Zenchef. Dessa forma, podemos fornecer informações específicas.

Se quiser criar uma parceria oficial e integração com a Zenchef

Registe-se em https://www.zenchef.com/integrations

Utilização da API do Zenchef

Todas as chamadas são monitorizadas pela Zenchef. Confiamos nos nossos clientes e parceiros para que manuseiem a API da Zenchef de forma responsável. Caso contrário, a Zenchef tem o direito de encerrar unilateralmente a integração.

Para chamadas que obtêm uma resposta em menos de 1s, é possível emitir 100 por minuto. Para chamadas com mais de 1s, elas devem ser sequenciais, não paralelizadas, de modo que você espere pela resposta antes de emitir a próxima chamada. A paginação deve estar na região de 250-500 para evitar fazer muitas chamadas pequenas.

Não há problema em fazer uma chamada inicial para recuperar lentamente a lista completa de fichas de clientes, reservas ou outras informações durante a integração, mas deve haver um mecanismo diferente para recuperar apenas as actualizadas desde a última chamada.

O que é suportado?

Abaixo encontra-se uma lista do que é suportado. Se não conseguir encontrar o seu caso de utilização específico, contacte api-tech-help@zenchef.com para obter mais informações.

Reservas e disponibilidades Verificar a disponibilidade e o horário de funcionamento do restaurante.  
Reservas e disponibilidades Obter reservas com alguns filtros adicionais.  
Reservas e disponibilidades Criar novas reservas e modificar as reservas existentes.  
Reservas e disponibilidades Atualizar o estado de uma reserva. Por exemplo, cancelar.  
Reservas e disponibilidades Obter uma visão geral das experiências vendidas, dos vales de oferta e das encomendas de takeaway.  
Serviços Obter os detalhes do serviço e atualizar as definições.  
Metadados do restaurante Obter informações gerais sobre o restaurante.  
Metadados do restaurante Atualizar as definições do restaurante.  
Mesas e salas Obter quartos e mesas do restaurante.  
Gestão de hóspedes Obter os perfis dos convidados.  
Gestão de hóspedes Criar e modificar perfis de convidados.  
Reviews Obter comentários. Criar respostas.  
Webhooks Receba uma notificação quando uma reserva for efectuada ou actualizada.  
  Obter webhooks instalados Só pode ser definido 1 URL de webhook por restaurante. Isto pode ser modificado diretamente através do ZenchefOS.
  Adicionar novos webhooks e modificar webhooks existentes. Só pode ser definido 1 URL de webhook por restaurante. Isto pode ser modificado diretamente através do ZenchefOS.
  Eliminar webhooks. Só pode ser definido 1 URL de webhook por restaurante. Isto pode ser modificado diretamente através do ZenchefOS.
  Receber mensagens dos hóspedes.  
  Enviar mensagens aos convidados.