Configuração do Lojista

Esta etapa trata do fluxo de cadastro e configuração comercial do estabelecimento para habilitar o canal de comunicação entre a plataforma e o sistema parceiro. Antes de iniciar a operação, o integrador deve vincular a loja na estrutura do Open Delivery para que ela passe a receber os eventos.

🛠️ Como realizar o onboarding da loja:

Para ativar o módulo e configurar o endereço onde sua aplicação receberá os alertas automatizados de novos pedidos, configure o seguinte endpoint:

PUT

/v1/merchantOnboarding/{merchantIdIntegrator}

Exemplo Payload - Onbording uso com webhook

{
  "ordersWebhookURL": "url do seu weboohk",
  "orderingAppMerchantId": "96493",
  "getMerchantURL": {
    "baseURL": "url da sua API",
    "apiKey": "senha-forte"
  }
}

Exemplo Payload - Onbording uso com pooling

{
  "orderingAppMerchantId": "96493",
  "getMerchantURL": {
    "baseURL": "url da sua API",
    "apiKey": "senha-forte"
  }
}

Parâmetros do Corpo (Payload)

Campo	Obrigatório	Descrição / Significado no aiqfome
ordersWebhookURL	❌	A URL pública de callback estruturada no seu sistema onde nossa plataforma disparará as notificações automatizadas de novos pedidos e mudanças de status.
orderingAppMerchantId	❌	ID da loja do Aiqfome.
getMerchantURL[]	❌
getMerchantURL[].baseURL	✅	O endereço de URL base de destino utilizado para a comunicação e requisições da API do parceiro.
getMerchantURL[].apiKey	❌	Chave de autenticação (Token / API Key) necessária para validar o acesso às rotas do sistema parceiro.

Atualização Dinâmica de Vínculo: Caso um restaurante que já possua um identificador ativo (integrator_merchant_id) receba uma nova solicitação de onboarding vinda de outro ERP, o sistema do aiqfome substituirá e atualizará automaticamente o mapeamento e a URL de destino com os novos parâmetros enviados.