Ex.: O objetivo deste manual é orientar sobre o fluxo de movimentações do beneficiários de intercambio, descontinuando os processos de A1300, A100 e A200.
Âncora
funcionalidade
funcionalidade
✅ Funcionalidade
Explicar a funcionalidade do recurso em tópicos.
Exemplo:
Envio da inclusão, alteração ou exclusão do beneficiário.
Movimentações serão enviadas automaticamente pela rotina do sistema;
Permite analisar se houve sucesso ou falha no envio dos dados para a Unimed Brasil.
Âncora
config
config
⚙️ Configurações
Manter apenas o requisito a ser escrito.
🛠️ Configurações/Requisitos
Inserir aqui todos os Direitos que influenciam nas rotinas tratadas neste manual:
Ex.:
Para poder utilizar o recurso, precisamos fazer as configurações necessárias para utilizar as api’s api_ptu e api_integraapis, que são as responsáveis por essa integração. Nessa tela, iremos procurar as api’s api_integraapis e a api_ptu, deixar seu status como ativo e indicar seu devido endpoint com as portas 15370 para api_integraapis e a 15380 para a api_ptu
Módulo ADM > Configurações > Cadastro de API’s
Após configurar a API, iremos fazer o cadastro de quatro integrações, onde três serão referentes às movimentações(Inclusão, alteração e exclusão) e a quarta é a que vai identificar qual tipo de movimentação que o beneficiário precisa ir.
Módulo Adm > Configurações > Cadastro de integrações
Expandir
title
Detalhes das configurações de integração
Como podemos ver na imagem acima, indicamos que seu tipo é API, o integrador é o Registra integração, o sistema de origem é Independente, o Fornecedor é Solus e o serviço utilizado é o Integração de Beneficiários ao Cad Benef.
O campo Url pode ficar em branco nesse caso
Expandir
title
Integração de Inclusão
O fornecedor dessa é o PTU, onde o serviço utilizado para ela é o Cadbenef - inclusão.
Nesse cadastro também indicamos a URL do serviço, que podemos encontrar no Manual de integrações que contém a url necessária para cada tipo de movimentação.
Continuando com o cadastro vamos até a aba “Configurações API”, onde vamos indicar que o content type da requisição é JSON, seu método http é o POST(pois é o de inclusão), e o status code de resposta é o 201.
Depois disso vamos até a aba “Configurações Autenticação” onde indicamos a forma de autenticação necessária para as movimentações. Em nosso caso é Bearer Token(JWT),além disso, precisamos indicar qual a Url utilizada para pegarmos o token, qual a chave no retorno da requisição em que teremos o token e qual a que indica o tempo de validade dele. Informamos também o método http utilizado para solicitá-lo (que em nosso caso é Post), e indicamos o Content-Type que esperamos de retorno, que é um Json.
Expandir
title
Integração de Alteração
O cadastro das movimentações, possuem basicamente os mesmos dados, onde as diferenças se resumem no serviço do fornecedor, no método http da request e no status code da resposta.
Dependendo da imagem que vai ser adicionada ao manual, é possível inserir um texto descritivo ao lado da imagem, assim como este exemplo. Porém, este recurso só funciona fora dos “quadros” ou do “Expandir”. Ele pode ser útil para a descrição de um erro ou de um comportamento específico que será demonstrado na imagem.
Observação: Não é possível criar outras macros neste “layout”.
Dependendo da imagem que vai ser adicionada ao manual, é possível inserir um texto descritivo ao lado da imagem, assim como este exemplo. Porém, este recurso só funciona fora dos “quadros” ou do “Expandir”. Ele pode ser útil para a descrição de um erro ou de um comportamento específico que será demonstrado na imagem.
Observação: Não é possível criar outras macros neste “layout”.Para acessar a tela de movimentações de beneficiários, deve entrar no módulo PTU > Movimentação > Movimentação de beneficiário.
Nela também temos filtros de busca para auxiliar na listagem, podendo indicar a situação do registro, status e etc. De início o sistema vai listar apenas as transações dos últimos 10 dias, podendo alterar entre 20, 30 ou independente se desejar. Temos também um botão chamado “Auto Consulta” que estará ativo assim que entrarmos na tela, onde a cada 5 segundos vai consultar se teve alguma nova movimentação no período. Caso não queira, basta clicar no botão para desativar e ativar esse recurso quando desejar.
Image Added
Filtros
Descrição
Opções
Expandir
title
Expandir se houver necessidade
Nota
Documentação elaborada com base na versão vigente do sistema.