CallbackProtheus (STATUS: VARIFICANDO)

Documentação Técnica

Histórico de Versões

Descrição

Esta biblioteca é utilizada como callback (webhook) para receber as respostas do processamento assíncrono realizado pelo Protheus, tratando o retorno, atualizando o status correspondente e acionando rotinas inteligentes quando aplicável.

Fila de Processamento

Descrição Conceitual

Realiza a realiza a notificão por email de itens que estão a mais de 30 minutos aguardando processamento no Protheus (situação = 'Aguardando Processamento no Protheus'). 

Tratamento de retorno

Persistência do resultado: o endpoint utiliza a operação set da fila para atualizar o item na tabela wosk_queue com retorno, mensagem, requisição, tempo e situação de processamento.

Situações utilizadas:
- 2: Sucesso.
- 4: Erro.
- 5: Aguardando finalização do processamento.

Encaminhamento em cenário de erro

Quando o callback indica erro (SITUACAO=0), o item é atualizado com situação 4. Exceção: se a mensagem contiver "já cadastrado", o item é marcado como sucesso (situação 2).

Notificação

SELECT
    `token`,
    `acao`,
    `chave`,
    `data_adicionado`,
    `data`,
    `mensagem`
FROM
    `{BASE_INTEGRADOR}`.`wosk_queue`
WHERE
    `situacao` = 5
    AND `data_adicionado` <= '{DATA_LIMITE}'
ORDER BY
    `data` ASC

Endpoint (API)

O endpoint recebe callbacks do Protheus com o resultado do processamento de itens enviados pelo LINX. Valida os parâmetros obrigatórios, resolve o token via respostaRecebidaCallback (chave FILIAL-ID), localiza o item na wosk_queue, atualiza a situação conforme SITUACAO (0=erro, 1=sucesso, 2=aguardando) e, quando a situação final não for 5, aciona rotinas inteligentes para determinados serviços (cupom fiscal, cupom ecommerce, documento de saída, cancelamento de cupom fiscal).

Estruturação de Dados

Parâmetros de entrada (obrigatórios)

Parâmetro opcional

DETALHE (array): complemento das informações processadas; quando presente, é gravado em retorno do item na fila.

Valores de saída

O endpoint retorna o mesmo objeto de entrada, acrescido de Mensagem ("OK" ou "ERRO") e Mensagem Detalhada com o resultado ou a mensagem de erro.

Tratamento de Dados

Mapeamento de INTEGRADOR: quando o valor for "cupom" (case-insensitive), é convertido para ProtheusCupom para resolução do token. Atualização de situacao conforme SITUACAO: 0→4 (erro), 1→2 (sucesso), 2→5 (aguardando). Tratamento especial: quando situacao for 4 e a mensagem contiver "já cadastrado" (case-insensitive), o item é reclassificado para situação 2 (sucesso).

Integração com o Protheus

O endpoint é chamado pelo Protheus (integração inversa). Não realiza requisições HTTP ao Protheus.

Tratamento de retorno

Em sucesso, retorna Mensagem = "OK" e Mensagem Detalhada = "Registrado com sucesso.". Em erro, retorna Mensagem = "ERRO" e Mensagem Detalhada com a exceção.

Encaminhamento em cenário de erro

Quando ocorre exceção (registro não encontrado, situação inválida, SITUACAO não esperada), o endpoint retorna Mensagem = "ERRO" e interrompe o fluxo sem atualizar a fila.

Notificação

Não há notificação específica do endpoint. A notificação de itens aguardando (situação 5) é realizada pela Fila de Processamento.

Rotinas Inteligentes

Cupom Ecommerce Integrado: chamada quando o callback indica sucesso ou erro (situação diferente de 5) e o serviço é ProtheusCupomFiscal, ProtheusCupomFiscalEcommerce, ProtheusCupomFiscalOmni ou ProtheusCupomFiscalPontual. Aciona a rotina de cupom ecommerce integrado para a chave do item.
link: Cupom Ecommerce Integrado

Cupom Fiscal Integrado: chamada nas mesmas condições acima. Aciona a rotina de cupom fiscal integrado para a chave do item.
link: Cupom Fiscal Integrado

Documento de Cancelamento de Cupom Fiscal: chamada nas mesmas condições acima. Aciona a rotina de cancelamento de cupom fiscal para a chave do item.
link: Documento de Cancelamento de Cupom Fiscal

Documento de Saida Integrado: chamada quando o serviço é ProtheusCupomFiscalFull e a situação final não é 5. Aciona a rotina de documento de saída integrado, cupom ecommerce integrado, cupom fiscal integrado e documento de cancelamento de cupom fiscal para a chave do item, com parâmetros adicionais para processamento em lote.
link: Documento de Saida Integrado

Fluxo do Processo

Critérios de Aceitação