Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.


CONTEÚDO

  1. Visão Geral
  2. Exemplo de utilização
  3. Tela XXX
    1. Outras Ações / Ações relacionadas
  4. Tela XXX
    1. Principais Campos e Parâmetros
  5. Tabelas utilizadas


01. VISÃO GERAL

Este documento tem como objetivo orientar a utilização da API guiaAutorizacoes Extrato de Autorizações para utilizar na integração do TOTVS Saúde Planos Linha Protheus com a Mobile Saúde, onde será disponibilizado ao beneficiário a relação das suas autorizações, por status, e possibilitar a visualização dos itens da guia e imprimir a guia completa em PDF.

A API utilizará o padrão REST.

02. EXEMPLO DE UTILIZAÇÃO

Lista de métodos utilizados na API:

...

A autenticação dos métodos listados abaixo é realizado através da Api /token, onde será retornado a chave e token a ser adicionado no header de cada método.

Método guiaAutorizacoes

Este método irá retornar a lista com todas as solicitações de autorização do usuário, conforme layout que será descrito abaixo. Este método deve retornar o cabeçalho da autorização.

Regras de Negocio do Método

Quando o beneficiário solicitado for o titular, será retornado as suas autorizações e de todo o grupo familiar.

Quando o beneficiário solicitado for um dependente, será retornado apenas as suas próprias autorizações.

Endpoint

UrlMétodoHeader Content-TypeDescrição
https://<url>:<porta>/rest/mobileSaude/v1/guiaAutorizacoesPOSTapplication/jsonRetorna uma lista com as guias de autorização

Parâmetros de Entrada do Método

ParâmetroObrigatórioTipoDescrição
chaveBeneficiarioSimStringChave do Beneficiário (CPF ou Matricula)
chaveBeneficiarioTipoSimStringTipo de Login do Beneficiário(CPF ou Matricula)
multiContractSimBooleanUtilização de Multi Contratos pelo Beneficiário
dataInicialNãoStringData inicial do extrato de autorizações
dataFinalNãoStringData final do extrato de autorizações

Exemplo

Bloco de código
languagec#
themeMidnight
titleRequest body
linenumberstrue
collapsetrue
{
    "chaveBeneficiarioTipo": "CPF",
    "multiContract": true,
    "chaveBeneficiario": "76461633090",
    "dataInicial": "2022-01-01",
    "dataFinal": "2022-02-04"
}

...

Bloco de código
languagec#
themeMidnight
titleRetorno API - Falha
linenumberstrue
collapsetrue
{
    "status": false,
    "motivoCritica": "Não existem autorizações a serem visualizadas"
}


Veja um exemplo de como o a comunicação com a API é feita na prática: 

Galeria



03. TELA XXXXX

Outras Ações / Ações relacionadas

AçãoDescrição

04. TELA XXXXX

Principais Campos e Parâmetros

CampoDescrição


Card documentos
InformacaoUse esse box para destacar informações relevantes e/ou de destaque.
TituloIMPORTANTE!


05. TABELAS UTILIZADAS

BEA - Cabeçalho das Guias de Autorizações

BE2 - Itens das Guias Autorizações

BE4 - Cabeçalho das Guias de Internações

BEJ - Itens das Guias de Internações

B4Q - Cabeçalho das Guias de Prorrogação de Internação

BQV - Itens das Guias de Prorrogação de Internação (Evolução das Diárias)

B4A - Cabeçalho das Guias de Anexos Clínicos 

B4C - Itens das Guias de Anexos Clínicos