[Novidade] Vendas: Consulta de Ocorrências da Venda Online via API

Agora no Bluesoft ERP, é possível consultar as ocorrências do processo de Venda Online por meio de nossas novas APIs.

Como Irá Funcionar?

A nova API pública de Ocorrências disponibiliza dois novos endpoints:

1. Consultar Ocorrências (GET)

• Endpoint: api/vendas/vendaonline/ocorrencias
• Filtros:
  • data (Obrigatório): A busca deve ser realizada definindo uma data específica.
  • lojaKey (Opcional): Se informado, restringe o resultado à loja solicitada (desde que o usuário autenticado tenha permissão de acesso a ela). Se omitido, a API considerará automaticamente todas as lojas às quais o usuário tem acesso.
• Retorno: O resultado é retornado no formato paginado padrão das APIs públicas do Bluesoft ERP.

2. Obter Arquivo da Ocorrência (GET)

• Endpoint: /vendas/vendaonline/ocorrencias/{vendaOnlineLogKey}/arquivo
• Regra Importante: Para garantir a integridade dos dados e evitar falhas de conversão, este endpoint só permitirá a obtenção de arquivos cuja origem seja integrações via API de cupons.

Funcionamento da API

Abaixo, veja como o fluxo de requisição se comporta em ambas as situações de obtenção de arquivo (sucesso e bloqueio preventivo):

Fluxo de Sucesso vs. Bloqueio Preventivo

Segurança e Governança

Para manter o controle de acesso e auditoria sobre os dados, os novos endpoints contam com regras de governança exclusivas:

• Permissões Independentes:
  • A permissão para consultar as ocorrências (Consultar Ocorrências do Venda Online via API) é distinta e independente da permissão para visualizar o conteúdo do arquivo (Obter Arquivo da Ocorrências do Venda Online via API). Você poderá conceder a um usuário ou sistema externo a permissão de consulta a lista de falhas sem, necessariamente, permitir que ele acesse os dados do arquivo.
• Escopo de Lojas:
  • O sistema valida o escopo de lojas associado às credenciais do usuário autenticado. Se houver uma tentativa de consultar ou buscar dados de uma lojaKey fora do seu escopo de acessos permitidos, a API retornará o erro correspondente.

Observações Importantes!

• Documentação Completa: A especificação técnica detalhada, parâmetros aceitos e esquemas de dados de entrada e saída já estão totalmente mapeados e disponíveis na nossa central de documentação Swagger da API pública.
• Consistência: As regras de negócio internas aplicadas aos filtros e ordenações (que priorizam as ocorrências exibindo-as em formato decrescente pela data do ocorrido) continuam exatamente iguais às aplicadas nas telas nativas do ERP.

Para conhecer mais sobre como é a utilização dessa ferramenta, clique aqui.

Para saber mais sobre a utilização das APIs do ERP, clique aqui.