¶ Rotinas do Sistema
O Syn Privado permite executar diversas rotinas do sistema que possuem o botão de execução ►, incluindo:
- Rotinas de apuração.
- Consultas personalizadas.
- Processos específicos.
Para executar rotinas no sistema Questor, você precisará das seguintes informações:
- Token de Login
- Nome Interno da rotina (_AActionName).
- Parâmetros da Rotina.
Com esses dados em mãos, será possível executar qualquer rotina desejada.
¶ Endpoint para Executar Rotinas
O Endpoint utilizado para a execução de processos é: GET - api/TnWebDMProcesso/ProcessoExecutar
Parâmetros Necessários
- _AActionName: Nome interno da rotina a ser executada.
Além dos parâmetros mencionados, caso a rotina possua parâmetros obrigatórios, será necessário informar um Body na requisição. Para construir este Body, utilize o retorno do Endpoint GET - api/TnWebDMDadosObjetos/Pegar, apresentado na seção de primeiros passos.
¶ Exemplo: Apuração de Impostos Estaduais
URL da Requisição
http://localhost:8080/api/TnWebDMProcesso/ProcessoExecutar?_AActionName=TnFisDPApurarImpEstadual
¶ Body da Requisição
Resposta Esperada:
⚠️ Atenção: Os parâmetros no Body podem variar conforme a rotina executada.
¶ Parâmetros Especiais
Em algumas rotinas específicas, pode ser necessário incluir parâmetros que não estão disponíveis pelo endpoint GET - api/TnWebDMDadosObjetos/Pegar.
Por exemplo, na importação de notas fiscais, é necessário incluir as notas no Body da requisição. Isso exige os seguintes parâmetros:
pNomeArquivo: Nome do arquivo .xml a ser importado.
- Obrigatório para importação de Arquivo Único.
- Para vários arquivos, utilizar um asterisco (*).
pNomePasta_DIRABRIR: Arquivo .xml compactado em um arquivo .zip. Para múltiplos arquivos .xml, todos devem ser compactados juntos.
O parâmetro inclui:
- FileName: Nome do arquivo compactado com extensão .zip.
- Data: Conteúdo do arquivo .zip, convertido para Base64.
¶ Exemplo: Importação de CFe
http://localhost:8080/api/TnWebDMProcesso/ProcessoExecutar?_AActionName=TnArqDPImportarArqCFe
¶ Body da Requisição
¶ Mensagens de Confirmação
Em algumas rotinas, ao executar, o sistema pode solicitar uma confirmação.
Por exemplo, ao executar a rotina de Limpar/Apurar Impostos Federais, o sistema pode retornar a seguinte mensagem:
Para prosseguir, copie a mensagem, insira no Body e envie-a novamente, preenchendo o parâmetro "Resposta" com:
- 0 para "SIM".
- 1 para "NÃO".
¶ Exemplo de Requisição
¶ Body da Requisição
¶ Validação de Respostas
A resposta ao executar uma rotina via API deve ser equivalente à obtida ao realizar o mesmo processo manualmente no sistema.
Se a requisição retornar um status 200 mas o resultado indicar um erro, revise os parâmetros enviados no Body para garantir que estão corretos.