Buscar autorizações do beneficiário
🌐 URLs dos Ambientes
🔹 Homologação
https://integracao.hml.cloud.medsenior.com.br/api/v1/beneficiario/autorizacoes?StatusSolicitacao={{statusSolicitacao}}&Matricula={{matricula}}&Cpf={{cpf}}&CodigoTuss={{codigoTuss}}&page={{page}}&pageSize={{pageSize}}
🔹 Produção
https://integracao.medsenior.com.br/api/v1/beneficiario/autorizacoes?StatusSolicitacao={{statusSolicitacao}}&Matricula={{matricula}}&Cpf={{cpf}}&CodigoTuss={{codigoTuss}}&page={{page}}&pageSize={{pageSize}}
Repita os parâmetros
Matricula,CpfouCodigoTussna query string para enviar múltiplos valores (&Matricula=12345&Matricula=67890).
📌 Endpoint
GET /api/v1/beneficiario/autorizacoes
🔐 Autenticação
Este endpoint requer token Bearer válido e as roles Administrador ou Leitor já aplicadas ao grupo beneficiario.
Authorization: Bearer TOKEN_GERADO_NA_AUTENTICACAO
🔽 Cabeçalhos
| Nome | Valor |
|---|---|
| accept | application/json |
| content-type | application/json |
🔽 Parâmetros de Entrada (query string)
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| StatusSolicitacao | enum BuscarBeneficiarioAutorizacaoStatus (int ou nome) | Não | Pode ser informado pelo número do enumerador (5) ou pelo nome (PreAutorizadoPendenteExecutante). Quando omitido, assumimos o status Pré-autorizado, pendente executante (valor 5). |
| Matricula | string[] (multi-value) | Não | Matrículas numéricas dos contratos ativos do beneficiário. Informe cada valor repetindo o parâmetro (Matricula=123&Matricula=456). |
| Cpf | string[] (multi-value) | Não | CPFs dos beneficiários (apenas dígitos). Pode ser informado em conjunto com os demais filtros. |
| CodigoTuss | string[] (multi-value) | Não | Códigos TUSS dos procedimentos que compõem a autorização. Auxilia a restringir a busca a um exame específico. |
| page | int | Não | Página da consulta (padrão 1). |
| pageSize | int | Não | Quantidade de registros por página (padrão 25). |
🎯 Status disponíveis (BuscarBeneficiarioAutorizacaoStatus)
| Valor | Nome (enum) | Descrição retornada |
|---|---|---|
| 1 | Autorizado | Autorizado |
| 2 | EmAnalise | Em análise |
| 3 | Negado | Negado |
| 4 | PedidoParaAnalise | Pedido para análise |
| 5 | PreAutorizadoPendenteExecutante | Pré-autorizado, pendente executante |
| 6 | ProrrogacaoIntercorrenciaEmAnalise | Prorrog/intercor em análise |
| 7 | ProrrogacaoIntercorrenciaParaAnalise | Prorrog/intercor p/ análise |
| 8 | RegistroDeSeriadoAnalisado | Registro de Seriado analisado |
🔄 Exemplo de Requisição
🔹 Ambiente de homologação
curl -X 'GET' \
'https://integracao.hml.cloud.medsenior.com.br/api/v1/beneficiario/autorizacoes?StatusSolicitacao=5&Matricula=12345&Matricula=67890&Cpf=12345678901&CodigoTuss=40801095&page=1&pageSize=10' \
-H 'accept: application/json' \
-H 'authorization: Bearer TOKEN_GERADO_NA_AUTENTICACAO' \
-H 'content-type: application/json'
🔹 Ambiente de produção
curl -X 'GET' \
'https://integracao.medsenior.com.br/api/v1/beneficiario/autorizacoes?StatusSolicitacao=PreAutorizadoPendenteExecutante&Matricula=12345&Cpf=12345678901&page=1&pageSize=10' \
-H 'accept: application/json' \
-H 'authorization: Bearer TOKEN_GERADO_NA_AUTENTICACAO' \
-H 'content-type: application/json'
✅ Resposta de Sucesso
- Status Code:
200 OK. - Corpo: objeto paginado (
ServiceResultPaged) com metadados e lista ordenada pelaDataSolicitacao.
{
"totalRecords": 1,
"totalPages": 1,
"page": 1,
"pageSize": 10,
"data": [
{
"guia": "240300123",
"beneficiario": {
"nome": "Ana Beatriz Souza",
"cpf": "12345678901",
"matricula": 12345,
"contatos": [
{
"tipoContato": "Celular",
"contato": "27999998888",
"comercial": false,
"residencial": false,
"cobranca": false,
"responsavel": false
}
]
},
"dataSolicitacao": "2024-03-15T10:23:00Z",
"dataVencimento": "2024-04-14T23:59:59Z",
"profissionalSolicitante": {
"nome": "Dr. Marcelo Lima",
"conselhoRegionalMedicina": "CRM-ES 12345"
},
"status": "Autorizado",
"tipo": "SADT",
"procedimentos": [
{
"codigoTUSS": "40801095",
"nomeProcedimento": "Ultrassonografia de Abdômen",
"dataSolicitacao": "2024-03-15T10:23:00Z",
"dataAprovacao": "2024-03-15T12:05:00Z",
"statusProcedimento": "Autorizado",
"executante": "Unidade Vitória",
"dataInclusao": "2024-03-15T10:23:00Z",
"quantidadeLiberada": 1,
"quantidadeSolicitada": 1
}
]
}
],
"messages": null
}
ℹ️ Observações de negócio
- Quando
StatusSolicitacaonão é informado, o serviço assume o enumeradorPreAutorizadoPendenteExecutante(valor5), que representa o status textual "Pré-autorizado, pendente executante", e retorna apenas guias nessa situação. - As autorizações são buscadas diretamente no Portal do Cliente com
Includepara Beneficiário, Contratos, Contatos e Procedimentos, garantindo que o payload esteja completo para exibição. - O filtro por
Matriculaexige apenas números; qualquer valor não numérico interrompe a consulta com400 A matrícula informada é inválida. - A resposta omite campos nulos para reduzir o payload, seguindo
JsonIgnoreCondition.WhenWritingNullconfigurado globalmente. - Quando não há resultados,
datavem vazio etotalRecordsfica0, mantendo o200 OK.
❌ Códigos de Erro
| Status Code | Significado | Descrição |
|---|---|---|
| 400 | Bad Request | Matrícula com caracteres inválidos. |
| 401 | Unauthorized | Token ausente ou inválido. |
| 403 | Forbidden | Token válido, mas usuário sem as roles Administrador ou Leitor. |
| 500 | Server Error | Erro inesperado no Portal do Cliente ou ao acessar o banco de dados. |