Agendar demonstração

Desenvolvedores

Informações técnicas para desenvolvedores

Integração Open Delivery

Selo Open Delivery Verificado

A Prefiro Delivery possui integração nativa e verificada com o padrão Open Delivery, permitindo que sistemas parceiros se integrem de forma padronizada, sem integrações proprietárias ponto a ponto.

O Open Delivery define contratos claros para troca de informações entre plataformas de pedido, sistemas de gestão e demais participantes do ecossistema de food service.

A Prefiro mantém duas versões em paralelo: a V1 (ativa, limitada a pedidos) e a V2 (mais completa). Novas integrações devem preferir a V2, cientes de que o protocolo ainda está em Release Candidate e pode evoluir até a versão estável — com convivência de versões se houver breaking changes relevantes.

Versões da integração

A V2 do protocolo Open Delivery está em Release Candidate (V2.0.0-rc). Até a versão estável, o contrato ainda pode evoluir. Se houver breaking changes consideráveis, a Prefiro disponibilizará uma nova versão da API e manterá esta RC disponível para quem já integrou. A V1 continua ativa durante a transição.

V1 (ativa)

V2 (mais completa — Release Candidate)

Módulos disponíveis

Os módulos abaixo estão disponíveis conforme a versão da integração:

  • Pedidos (Orders) — V1 e V2: consumo de pedidos e eventos via polling ou webhook, consulta de detalhes e transições de lifecycle conforme a especificação.
  • Clientes (Customer) — somente V2: consulta dos dados dos clientes do estabelecimento.
  • Fidelidade (Loyalty/cashback) — somente V2: programa de cashback no padrão Open Delivery.

Papéis na integração

A Prefiro Delivery atua como Ordering Application, sendo responsável pela origem dos pedidos e pela publicação dos eventos. O sistema parceiro atua como Software Service (PDV, CRM ou equivalente), autenticando-se com as credenciais do App e consumindo a API conforme o padrão Open Delivery.

Criação do App pelo restaurante

Para liberar o acesso à integração, o administrador do restaurante irá:

  • Acessar o painel da Prefiro Delivery
  • Criar um novo App de Open Delivery (Integrações -> Open Delivery)
  • Definir os estabelecimentos/unidades que o App poderá acessar
  • Concluir a criação do App e liberar as credenciais (Client ID e Client Secret) ao sistema parceiro

Documentação

Open Delivery V1 (spec oficial v1.6 — só pedidos):
https://developer.opendelivery.com.br/api-portal/content/docs

Open Delivery V2 — documentação Prefiro:
https://www.prefirodelivery.com.br/api-docs/

Open Delivery V2 — especificação do protocolo:
https://docs.opendelivery.com.br/

Suporte

Em caso de dúvidas sobre a criação do App ou das credenciais de acesso, o restaurante pode entrar em contato com o suporte da Prefiro Delivery informando:

  • Nome do sistema parceiro

Outras Integrações

Além do padrão Open Delivery, você também pode integrar sua operação com a API própria da Prefiro Delivery. Essa API oferece acesso a recursos e funcionalidades que ainda não estão disponíveis no módulo Open Delivery, por exemplo:

  • Consultar, criar e atualizar produtos
  • Listar, criar e atualizar categorias
  • Listar estabelecimentos e o status deles
  • Marcar pedido como pago e gerenciar webhook da integração

Também é possível consultar pedidos, acompanhar alterações de status e automatizar processos. A documentação completa (endpoints, autenticação e exemplos) está disponível aqui:

https://documenter.getpostman.com/view/11644806/UVsEUokz