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 consumam pedidos e eventos de forma padronizada.

O Open Delivery define contratos claros para troca de informações entre plataformas, reduzindo a necessidade de integrações proprietárias.

Documentação oficial do padrão:
https://developer.opendelivery.com.br/api-portal/content/docs

Conceito de Merchant

No contexto do Open Delivery, o Merchant representa o sistema parceiro que irá consumir os pedidos originados na Prefiro Delivery.

Se o seu sistema também adota o padrão Open Delivery como merchant, informe os dados de acesso à sua API ao administrador do restaurante. Com essas informações, ele poderá realizar o cadastro do Merchant e a criação do App de Open Delivery no painel da Prefiro Delivery, permitindo a consulta automática de produtos, facilitando o cadastro dos códigos externos e habilitando futuras funcionalidades.

Caso contrário, informe apenas um identificador do seu sistema ao administrador do restaurante.

Como a integração funciona na Prefiro Delivery

  • O sistema parceiro define os dados do Merchant
  • O restaurante cadastra essas informações no painel da Prefiro Delivery
  • O painel gera as credenciais do App de Open Delivery
  • O sistema parceiro passa a consumir os pedidos conforme o padrão Open Delivery

O que vocês precisam fornecer ao restaurante

Para que o restaurante consiga criar o App de Open Delivery no painel do Prefiro Delivery, o sistema parceiro deve fornecer uma das opções abaixo:

Opção 1 – Informar apenas o identificador do sistema
  • Identificador do sistema parceiro (ex: slug ou código único)
  • Webhook URL (opcional): endpoint para recebimento de eventos

Utilize esta opção caso o seu sistema não implemente o padrão Open Delivery como merchant. O identificador do sistema é um campo previsto no padrão Open Delivery e será enviado nos detalhes do pedido.

Opção 2 – Integração como Merchant Open Delivery
  • Merchant URL: URL base da API do sistema parceiro
  • Merchant Token: token/chave de autenticação do Merchant
  • Webhook URL (opcional): endpoint para recebimento de eventos

Utilize esta opção caso o seu sistema implemente o padrão Open Delivery como merchant. Dessa forma, o Prefiro Delivery poderá consultar os produtos automaticamente, facilitar o cadastro dos códigos externos e habilitar futuras funcionalidades.

Criação do App pelo restaurante

Após receber os dados do Merchant, o administrador do restaurante irá:

  • Acessar o painel da Prefiro Delivery
  • Criar um novo App de Open Delivery ( Integração -> Open Delivery)
  • Informar os dados do Merchant fornecidos pelo sistema parceiro
  • Definir os estabelecimentos/unidades que o App poderá acessar
  • Concluir a criação do App e liberar o uso da integração

Sistemas que ainda não utilizam Open Delivery

Para adequação ao padrão, utilize a documentação oficial como referência para implementação:

https://developer.opendelivery.com.br/api-portal/content/docs

A Prefiro Delivery atua como um Ordering Application, sendo responsável pela geração dos pedidos, enquanto o sistema parceiro atua como o Merchant (Software Service), podendo consumir esses pedidos via polling ou webhook, conforme definido pelo padrão Open Delivery.

Atualmente, a Prefiro Delivery consome o endpoint do Merchant apenas para recuperar o id e o nome do sistema parceiro. Essas informações são sempre devolvidas nos detalhes do pedido.

Suporte

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

  • Nome do sistema parceiro
  • Dados do Merchant

Outras Integrações

Você também pode integrar sua operação com a API da Prefiro Delivery para consultar informações de pedidos, acompanhar alterações de status e automatizar processos com webhooks. A documentação completa (endpoints, autenticação e exemplos) está disponível aqui:

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