LogisticsWMS API & Webhooks

Para que serve

Permite que sistemas externos (o teu ERP, e-commerce à medida, ferramentas de BI, etc.) comuniquem com o WMS de duas formas complementares: webhooks e REST API.

Como funciona

• 🔔 Webhooks (WMS → exterior): o WMS envia automaticamente dados para os teus sistemas quando ocorrem eventos (ex.: encomenda criada, stock atualizado). Configura, por operação, o URL de destino; os pedidos de saída são autenticados com utilizador / password (HTTP Basic Auth).
• 🔑 Clientes API (exterior → WMS): sistemas externos autenticam-se e chamam a API do WMS diretamente para consultar ou alterar dados, em /api/external/v1/.
  1. Cria um cliente API — geram-se um Client ID e um Client Secret (o segredo só é mostrado uma vez).
  2. Troca as credenciais por um token JWT válido por 1 hora: POST /api/external/v1/auth/token.
  3. Usa o token como Authorization: Bearer <token> em todas as chamadas seguintes.
• Cada cliente API pode ser ativado / desativado, ter o segredo regenerado, ou ser eliminado — sem afetar os restantes.
• Todas as chamadas (webhooks e clientes API) ficam registadas na aba de Auditoria.
• A documentação técnica completa está no Swagger.

Como configurar

1. Ativa o plugin em Plugins → Outras Integrações.
2. Nas Definições Gerais, ativa as operações que queres expor e os valores predefinidos (ex.: se produtos criados via API têm sempre lote / data de validade).
3. Para notificar sistemas externos: configura os URLs de webhooks e as credenciais de autenticação de saída no separador Webhooks.
4. Para permitir chamadas ao WMS: cria um ou mais Clientes API no separador correspondente e partilha as credenciais com quem for consumir a API.

Notas importantes

• Guarda o Client Secret em local seguro assim que é gerado — não voltará a ser mostrado. Se o perderes, regenera-o.
• Os URLs de webhook têm de estar publicamente acessíveis para o WMS conseguir entregar as notificações.
• Para obter o client_id / client_secret iniciais, envia email para [email protected] com a empresa cliente do LogisticsWMS.

💡 Dica: dentro da aplicação, a página de configuração de cada plugin tem um botão Guia de Integração com o passo-a-passo técnico detalhado.