O Postman é uma solução para consultas de API, permitindo analisar de ponta-a-ponta os retornos.
A url para o download é https://www.getpostman.com/downloads/
Assim que o download for realizado e o software Instalado, abaixo seguem as instruções de uso. Antes de começar a configuração no Postman
, certifique-se que possua o arquivo JSON para importar as configurações. Caso não possua este, contate a equipe do Suporte ou seu Analista de Negócio responsável para adquirir o mesmo.
Para importar o arquivo de configuração, basta abrir o Postman
e clicar em Import.
Após Importado, aparecerá na aba do canto esquerdo a pasta com as configurações definidas. Ao clicar na aba, haverá quatro opções
Para logar, coloque seu login e senha no Body
Aguardar a resposta “200 OK”
Informe os dados da solicitação ( arquivos, perfil, código legado ) e clique em Send
O retorno ficará salvo em uma variável, chamada solicitacao que será utilizada na próxima etapa.
Para consultar o retorno já tipificado (executado no passo anterior) basta clicar em Send
.
Em Response é importante verificar o Status da tipificação:
Observações:
Para consultar documentos já tipificados, basta ingressar em Login (Etapa 1) e Solicitacao (Etapa 3) porém é necessário alterar a url de retorno.
Url de retorno: https://atomics-hom.simply.com.br/api/v1/tipificacao/{{solicitacao}}?detalhar=true&ocr=true
Por exemplo, para verificar o retorno do código de fila 7103950 basta trocar {{solicitacao}} pelo código(7103950). Sendo assim a url https://atomics-hom.simplycom.br/api/v1/tipificacao/7103950?detalhar=true&ocr=true
Este campo é utilizado, para pegar o retorno dos documentos, como no caso do IN100.
Observe que após ao “codArquivo=” devera ser inserido o código de solicitação gerado na aba Tipificação - Consulta.
No POSTMAN
para envio da tipificação apenas os campos CodigoLegado e PerfilTipificacao são obrigatórios.
CodigoLegado - Campo aberto, para controle com relação a alguma informação de outro sistema que deseje vincular a solicitação.
PerfilTipificacao - Você deve enviar um perfil que seja válido e previamente configurado com os documentos que serão enviados. Esse perfil deve ser pré-configurado no administrador do Atomics.
Você deve fazer um pooling verificando o campo Status. Sobre o campo ArquivoRetorno, ele só é retornado em algumas situações pré-configuradas no seu administrador
O CodigoArquivo, também só é informado mediante algumas configurações no seu perfil.