Detalhes Planos

Desvendando os Detalhes do Plano

Bem-vindo à documentação de Detalhes do Plano! Nossa API foi desenvolvida com o objetivo de fornecer informações detalhadas sobre os planos de saúde com base nas informações de uma proposta de simulação. Esta documentação abrangente irá guiá-lo na utilização efetiva do endpoint dedicado a obter os detalhes específicos do plano.

Esta API fornece detalhes do plano de saúde com base nas informações de uma proposta de simulação. O endpoint /api/Comparador/Saude é responsável por receber uma solicitação com os parâmetros adequados e retornar os detalhes do plano de saúde correspondente. Abaixo estão os exemplos de payload e resposta para ajudar você a entender a estrutura das requisições e respostas.

Gerar Infos Plano.

post

PostExample ``` [{ "copay": false, "idAdministradora": 0, "idPlano": 0, "idOperadora": 0, "id_tipo_modalidade": 0, "municipio": "", "uf": "", "usuarios": 0, "perfil": { "perfilCliente": [ 1, 2, 3, 4, 5 ], "produto": 0, "id_regiao": 0, "id_estado": 0, "id_cidade": 0, "tipoEmpresa": 0, "precificacao": 0, "copay": false, "titulares": 0, "cargo": 0, "profissao": 0, "limitador": 0, "operadoraAnterior": 0, "planoAnterior": 0, "acomodacao": 0, "oferta": 0, "operadoraPreferencial": 0, "bradescoCompulsorio": false, "desagruparPerfil": false, "contratacao": 0, "id_cliente": 0, "faixaetaria1": 0, "faixaetaria2": 0, "faixaetaria3": 0, "faixaetaria4": 0, "faixaetaria5": 0, "faixaetaria6": 0, "faixaetaria7": 0, "faixaetaria8": 0, "faixaetaria9": 0, "faixaetaria10": 0, "faixasAdicionais": [], "id_tipo_abrangencia": [ 1, 2, 3, 4 ] } }]

Parâmetro	Descrição
idAdministradora	id Operadora Administradora do plano odonto. (Geralmente a Mesma do Plano)
id_tipo_modalidade	Modalidade Plano
municipio	Nome Municipio ex: São Paulo
uf	Nome Uf: ex: São Paulo
copay	coparticipação(true or false)
perfilCliente	Array 1 a 5 ex: [1,2,3,4,5]
produto	id_produto
id_regiao	Não obrigatório
id_estado	CEP =>  codMunicipioIBGE => Tarifa/UfMunicipioPrecificacao/ return id_estado
id_cidade	CEP =>  codMunicipioIBGE => Tarifa/UfMunicipioPrecificacao/ return id
tipoEmpresa	1 a 8
precificacao	1 = Compulsoria, 2 = Flex
titulares	Número Titulares
profissao	Profissão
limitador	Limitador de valor R$ ex: 1000
operadoraAnterior	Não obrigatório
planoAnterior	Não obrigatório
acomodacao	0 = Ambos, 1 = Emfermaria, 2 = Privativo
oferta	Não obrigatório
operadoraPreferencial	Não obrigatório
bradescoCompulsorio	true ou false
desagruparPerfil	true ou false
contratacao	0 = Ambulatorial/Hospitalar, 1 = Hospitalar, 2 = Ambulatorial
id_cliente	id do Cliente
faixaetaria 1 a 10	0 ou Quantidade
faixasAdicionais	Array ex: [{"faixa": 79, "vidas": 3}]

Authorizations

Bearer

AuthorizationstringRequired

Autorização com Bearer. Exemplo: "Bearer {token}"

Bodyobject[]

application/jsontext/jsonapplication/*+json

idOperadorainteger · int32Optional

idPlanointeger · int32Optional

idAdministradorainteger · int32Optional

copaybooleanOptional

usuariosinteger · int32Optional

id_tipo_modalidadeinteger · int32Optional

ufstring | nullableOptional

municipiostring | nullableOptional

Responses

200

Success

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

post

/api/Comparador/Saude

HTTPcURLJavaScriptPython

POST /api/Comparador/Saude HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 692

[
  {
    "perfil": {
      "perfilCliente": [
        1
      ],
      "produto": 1,
      "id_regiao": 1,
      "tipoEmpresa": 1,
      "precificacao": 1,
      "copay": true,
      "titulares": 1,
      "cargo": 1,
      "codigoFaixa": 1,
      "limitador": 1,
      "operadoraAnterior": 1,
      "planoAnterior": 1,
      "oferta": 1,
      "contratacao": 1,
      "conjulgadoBradesco": true,
      "desagruparPerfil": true,
      "faixaetaria1": 1,
      "faixaetaria2": 1,
      "faixaetaria3": 1,
      "faixaetaria4": 1,
      "faixaetaria5": 1,
      "faixaetaria6": 1,
      "faixaetaria7": 1,
      "faixaetaria8": 1,
      "faixaetaria9": 1,
      "faixaetaria10": 1,
      "faixaetaria11": 1,
      "faixaetaria12": 1,
      "faixaetaria13": 1,
      "faixaetaria14": 1,
      "faixasAdicionais": [
        {
          "faixa": 1,
          "vidas": 1
        }
      ]
    },
    "idOperadora": 1,
    "idPlano": 1,
    "idAdministradora": 1,
    "copay": true,
    "usuarios": 1,
    "id_tipo_modalidade": 1,
    "uf": "text",
    "municipio": "text"
  }
]

application/jsontext/jsonapplication/*+json

{
  "sucesso": true,
  "mensagem": "text",
  "resposta": {
    "dados": [
      {
        "rowguid": "text",
        "idOperadora": 1,
        "operadora": "text",
        "logo": "text",
        "idPlano": 1,
        "plano": "text",
        "idAdministradora": 1,
        "administradora": "text",
        "valorTotal": 1,
        "percentualCopay": "text",
        "valorFaixaEtaria": [
          {
            "faixaEtaria": "text",
            "usuarios": 1,
            "valorUnitario": 1,
            "valorTotal": 1
          }
        ],
        "perfil": {
          "regiao": "text",
          "tipoEmpresa": "text",
          "coparticipacao": "text",
          "acomodacao": "text",
          "tipoContratacao": "text",
          "segmento": "text",
          "titulares": "text",
          "abrangencia": "text",
          "reembolsoConsultas": "text"
        },
        "idCargo": 1,
        "id_tipo_modalidade": 1,
        "ordemPlano": 1,
        "ordemOperadora": 1,
        "id_regiao": 1,
        "regiao": "text",
        "odonto": {
          "plano": "text",
          "valor": 1
        },
        "id_perfil_socioeconomico": 1
      }
    ],
    "quantidade": 1
  }
}

Example POST BODY

body.json

[
    {
        "copay": false,
        "idAdministradora": 1,
        "idPlano": 965,
        "idOperadora": 1,
        "id_tipo_modalidade": 1,
        "municipio": "São Paulo",
        "uf": "São Paulo",
        "usuarios": 2,
        "perfil": {
            "cargo": 1,
            "conjulgadoBradesco": false,
            "contratacao": 1,
            "copay": false,
            "desagruparPerfil": true,
            "faixaetaria1": 0,
            "faixaetaria2": 1,
            "faixaetaria3": 0,
            "faixaetaria4": 1,
            "faixaetaria5": 0,
            "faixaetaria6": 0,
            "faixaetaria7": 0,
            "faixaetaria8": 0,
            "faixaetaria9": 0,
            "faixaetaria10": 0,
            "faixaetaria11": 0,
            "faixaetaria12": 0,
            "faixaetaria13": 0,
            "faixaetaria14": 0,
            "id_regiao": 1,
            "limitador": 0,
            "oferta": 0,
            "operadoraAnterior": 0,
            "planoAnterior": 0,
            "perfilCliente": [
                1,
                2,
                3,
                4,
                5
            ],
            "produto": 4,
            "precificacao": 1,
            "tipoEmpresa": 8,
            "titulares": 1,
            "codigoFaixa": 0,
            "faixasAdicionais": []
        }
    }
]

Example RESPONSE BODY

body.json

{
    "sucesso": true,
    "mensagem": null,
    "resposta": [
        {
            "rowguid": "00000000-0000-0000-0000-000000000000",
            "idOperadora": 0,
            "operadora": "OPERADORA NOME",
            "logo": "https://example-url.com/dev/operadoras/00000000-0000-0000-0000-000000000000.svg",
            "idPlano": 0,
            "plano": "PLANO",
            "idAdministradora": 0,
            "administradora": "",
            "valorTotal": 0.0000,
            "percentualCopay": "Sem coparticipação (SEM remissão)",
            "valorFaixaEtaria": [
                {
                    "faixaEtaria": "00 a 18",
                    "usuarios": 0,
                    "valorUnitario": 0.0000,
                    "valorTotal": 0.0000
                },
                {
                    "faixaEtaria": "19 a 23",
                    "usuarios": 2,
                    "valorUnitario": 0,
                    "valorTotal": 0
                },
                // mais detalhes de faixas etárias
            ],
            "perfil": {
                "regiao": "",
                "tipoEmpresa": "Contrato Social",
                "coparticipacao": "Não",
                "acomodacao": "Enfermaria",
                // mais detalhes do perfil
            },
            "idCargo": 1,
            "id_tipo_modalidade": 1,
            "ordemPlano": 7,
            "ordemOperadora": 1,
            "id_regiao": 3,
            "regiao": "SP3",
            // mais detalhes do plano
        }
    ]
}

Biblioteca

Parametro	Descrição
perfilCliente	Array 1 a 5 ex: [1,2,3,4,5]
produto	id_produto
id_regiao	Não obrigatório
id_estado	CEP => /cep codMunicipioIBGE => Tarifa/UfMunicipioPrecificacao/ return id_estado
id_cidade	CEP => /cep codMunicipioIBGE => Tarifa/UfMunicipioPrecificacao/{cod_ibge}/ return id_cidade
tipoEmpresa	1 a 8
precificacao	1 = Compulsoria, 2 = Flex
copay	true ou false
titulares	Número Titulares
profissao	=> end point GET Entidade/Profissao/
limitador	Limitador de valor R$ ex: 1000
operadoraAnterior	Não obrigatório
planoAnterior	Não obrigatório
acomodacao	0 = Ambos, 1 = Emfermaria, 2 = Privativo
oferta	Não obrigatório
operadoraPreferencial	Não obrigatório
bradescoCompulsorio	true ou false
desagruparPerfil	true ou false
contratacao	0 = Ambulatorial/Hospitalar, 1 = Hospitalar, 2 = Ambulatorial
id_cliente	Seu id de Cliente
faixaetaria (1 a 10)	0 ou Quantidade
faixasAdicionais	Array ex: [{"faixa": 79, "vidas": 3}]
idAdministradora	ID Administradora do Plano
idPlano	ID do Plano
id_tipo_modalidade	Id do Tipo de Modalidade
municipio	Nome do Municipio ex: "São Paulo"
uf	Nome do Estado ex: "São Paulo"