Requisição síncrona

Com a requisição síncrona o requisitante será notificado em caso de sucesso ou erro no momento da tentativa de criação de uma requisição.

---

O objetivo da Requisição síncrona para os clientes com integração é a possibilidade do requisitante validar o sucesso ou o erro da criação da requisição diretamente na tela.

O usuário é avisado em caso de uma possível recusa ou problema, evitando assim, erros de inconsistência que poderiam ser verificados tardiamente.

Funcionamento da requisição síncrona

Nesta seção você poderá conferir o funcionamento da requisição síncrona de forma geral e detalhada através das imagens e da descrição das etapas que será apresentada na sequência.

Visão geral da requisição síncrona

Visão detalhada da requisição síncrona

Confira o fluxo detalhado da requisição síncrona com destaque para as atuações do Front-end e do Back-end. Nesta imagem você também pode ver as ações que ocorrem no Cliente e no ME.

Descrição das etapas da requisição síncrona

1. O Requisitante preenche os dados de criação da requisição via tela no ME;
2. O Requisitante aguarda o retorno em tela enquanto o ERP/Sistema está tentando se conectar com o ME;
3. A partir deste momento o ME envia o webhook prerequest.submitted para notificar a tentativa de criação da requisição para o ERP/Sistema integrado;
4. O ERP/Sistema faz o GET Get a pre-request based on the preRequestId das informações dessa requisição e efetua as validações necessárias;
5. Em seguida o ERP/Sistema pode seguir com 2 caminhos:

• Efetua o POST de aprovação da requisição: quando retorna que está tudo certo, através do endpoint POST Approves a pre-request.
• Efetua um POST de rejeição da requisição: quando existem erros, informando em quais campos e quais foram os erros, através do endpoint POST Reject a pre request based on the pre request Id and body information.

6. O back-end repassa essa informação para o serviço que o front-end vai consumir;
7. O front-end do ME exibe a requisição criada com sucesso, ou mostra a informação de que a requisição NÃO foi criada, se houver campos com erros a serem corrigidos;
8. O Requisitante efetua as correções se tiver algum campo com erro e reenvia a requisição.

📘 Nota

Os endpoints relacionados à tentativa de criação da requisição levam o nome de "Pré-requisição" (Pre-request) não por se tratar de um documento diferente, mas sim de um processo intermediário na criação da requisição.

Etapas da requisição síncrona no front-end

O front-end recebe a informação de sucesso ou erro no processamento de uma requisição para exibir em tela para o usuário final.

Passo a passo no front-end do ME:

1. O requisitante preenche os dados de criação da requisição via tela, completando as informações necessárias de cada item, conforme tela a seguir:

2. O requisitante clica em Avançar e é informado de que a requisição está sendo processada. Nestes segundos ocorre a integração com o ERP/Sistema.

3. Em seguida, o front-end retorna a tela de requisição indicando os erros nos itens ou pode retornar a tela com a requisição publicada com sucesso.

3.1 Na tela da etapa a seguir, existem campos com erros e, por isso, a requisição não foi publicada. Você pode expandir cada um dos itens para verificar quais foram estes erros e em quais campos.

3.2 Na etapa a seguir a requisição foi criada com sucesso.

Rascunhos

Todas as tentativas de criação de requisição que por algum motivo não deram certo, ficam salvas na lista de Rascunhos. Isto inclui as requisições que não foram criadas por motivo de campos com erros ou requisições que começaram a ser preenchidas, mas ainda não foram submetidas, por problemas de conexão, por exemplo.

Os rascunhos das criações de requisições serão mantidos até que se você termine de preenchê-los ou corrigi-los e faça o reenvio. Quando a requisição finalmente for criada, o rascunho será apagado.