Como Gerar uma Simulação

Envio de solicitação de simulação de Planos.

• Introdução

• Primeiro Passo ( Auth)

• Segundo Passo ( Perfil para simulação )

• Terceito Passo ( Call Api Autenticada)

  • API Simulação

• Quarto Passo ( Payload Comparador de Planos )

  • API Comprador

Introdução:

Neste documento vamos abordar os passos para criar uma simulação e assim obter as informações de cada planos

Primeiro Passo:

Primeiro precisamos estar autenticados e de posse de nosso access_token

Você pode obtê-lo a partir da seguinte documentação:

Autenticação Básica

Segundo Passo:

Preencimento das informações do objeto json a ser enviado no Body da requisição da simulação.

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}]

[{
   "perfilCliente": [],
   "produto": 0,
   "id_regiao": 0, 
   "id_estado": 0,
   "id_cidade": 0,
   "tipoEmpresa": 0,
   "precificacao": 0,
   "copay": false,
   "titulares": 0, 
   "profissao": 0,
   "limitador": 0,
   "operadoraAnterior": 0, 
   "planoAnterior": 0,
   "acomodacao": 0, 
   "oferta": 0,
   "operadoraPreferencial": 0, 
   "bradescoCompulsorio": false,
   "desagruparPerfil": true,
   "contratacao": 0,
   "id_cliente": 0,
   "faixaetaria1": 0,
   "faixaetaria2": 1,
   "faixaetaria3": 0,
   "faixaetaria4": 1,
   "faixaetaria5": 0,
   "faixaetaria6": 0,
   "faixaetaria7": 0,
   "faixaetaria8": 0,
   "faixaetaria9": 0,
   "faixaetaria10": 0,
   "faixasAdicionais": []
}];

Terceiro Passo:

Preenchimento das informações de auth necessárias. Segue ex:

Authorization: access_token

Postman. Methot POST

Enviar a requisição para o end-point:

Metodo POST Content-Type: application/json

Api Simulação

Gerar nova Simulação.

post

    POST EXAMPLE:
    [{
       "perfilCliente": [],
       "produto": 0,
       "id_regiao": 0, 
       "id_estado": 0,
       "id_cidade": 0,
       "tipoEmpresa": 0,
       "precificacao": 0,
       "copay": false,
       "titulares": 0, 
       "profissao": 0,
       "limitador": 0,
       "operadoraAnterior": 0, 
       "planoAnterior": 0,
       "acomodacao": 0, 
       "oferta": 0,
       "operadoraPreferencial": 0, 
       "bradescoCompulsorio": false,
       "desagruparPerfil": true,
       "contratacao": 0,
       "id_cliente": 0,
       "faixaetaria1": 0,
       "faixaetaria2": 1,
       "faixaetaria3": 0,
       "faixaetaria4": 1,
       "faixaetaria5": 0,
       "faixaetaria6": 0,
       "faixaetaria7": 0,
       "faixaetaria8": 0,
       "faixaetaria9": 0,
       "faixaetaria10": 0,
       "faixasAdicionais": []
    }];
            
**Dicionário:**
| 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/ return id        |
| tipoEmpresa           | 1 a 8                                                                               |
| precificacao          | 1 = Compulsoria, 2 = Flex                                                           |
| copay                 | Coparticipacao                                                                      |
| titulares             | Número Titulares                                                                    |
| profissao             | 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            | 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}"

Query parameters

pageinteger · int32Optional

quantityinteger · int32Optional

Bodyobject[]

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

perfilClienteinteger · int32[] | nullableOptional

Array 1 a 5 ex: [1,2,3,4,5]

produtointeger · int32Optional

id_produto

id_regiaointeger · int64Optional

Id da Regiao não obrigatório

id_estadointeger · int32Optional

CEP => /cep codMunicipioIBGE => Tarifa/UfMunicipioPrecificacao/ return id_estado

id_cidadeinteger · int32Optional

CEP => /cep codMunicipioIBGE => Tarifa/UfMunicipioPrecificacao/ return id

tipoEmpresainteger · int32 · min: 1 · max: 8Optional

1 a 8

precificacaointeger · int32 · min: 1 · max: 2Optional

1 = Compulsoria, 2 = Flex

copaybooleanOptional

Coparticipacao true ou false

titularesinteger · int32 · min: 1 · max: 32767Optional

Número Titulares

cargointeger · int32Optional

Tipo de Gargo Nao obrigatório

profissaointeger · int32Optional

Profissao ex: 1

codigoFaixainteger · int32Optional

Não obrigatório

limitadornumber · doubleOptional

Limitador de valor R$ ex: 1000

operadoraAnteriorinteger · int32Optional

Não obrigatório

planoAnteriorinteger · int32Optional

Id Plano anterior Não obrigatório

acomodacaointeger · int32 · max: 2Optional

0 = Ambos, 1 = Emfermaria, 2 = Privativo

ofertainteger · int32Optional

Não obrigatório

operadoraPreferencialinteger · int32Optional

Não obrigatório

bradescoCompulsoriobooleanOptional

true ou false

desagruparPerfilbooleanOptional

true ou false

contratacaointeger · int32Optional

0 = Ambulatorial/Hospitalar, 1 = Hospitalar, 2 = Ambulatorial

id_clienteinteger · int32Optional

id do Cliente

faixaetaria1integer · int32Optional

0 ou Quantidade

faixaetaria2integer · int32Optional

0 ou Quantidade

faixaetaria3integer · int32Optional

0 ou Quantidade

faixaetaria4integer · int32Optional

0 ou Quantidade

faixaetaria5integer · int32Optional

0 ou Quantidade

faixaetaria6integer · int32Optional

0 ou Quantidade

faixaetaria7integer · int32Optional

0 ou Quantidade

faixaetaria8integer · int32Optional

0 ou Quantidade

faixaetaria9integer · int32Optional

0 ou Quantidade

faixaetaria10integer · int32Optional

0 ou Quantidade

faixaetaria11integer · int32Optional

0 ou Quantidade

faixaetaria12integer · int32Optional

0 ou Quantidade

faixaetaria13integer · int32Optional

0 ou Quantidade

faixaetaria14integer · int32Optional

0 ou Quantidade

id_operadorasinteger · int32[] | nullableOptional

Array de id_operadora ex: [1,2,3,4]

id_tipo_abrangenciainteger · int32[] | nullableOptional

Array = [1,2,3,4]
1 = Regional 2 = Estadual = 3 Nacional 4 = Sem Informação (Nao Obrigatório)

Responses

200

Success

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

post

/api/Simulacao

HTTPcURLJavaScriptPython

POST /api/Simulacao HTTP/1.1
Host: gnesyspro-ms-tarifas-dev.dorconsultoria.com.br
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 697

[
  {
    "perfilCliente": [
      1
    ],
    "produto": 1,
    "id_regiao": 1,
    "id_estado": 1,
    "id_cidade": 1,
    "tipoEmpresa": 1,
    "precificacao": 1,
    "copay": true,
    "titulares": 1,
    "cargo": 1,
    "profissao": 1,
    "codigoFaixa": 1,
    "limitador": 1,
    "operadoraAnterior": 1,
    "planoAnterior": 1,
    "acomodacao": 1,
    "oferta": 1,
    "operadoraPreferencial": 1,
    "bradescoCompulsorio": true,
    "desagruparPerfil": true,
    "contratacao": 1,
    "id_cliente": 1,
    "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
      }
    ],
    "id_operadoras": [
      1
    ],
    "id_tipo_abrangencia": [
      1
    ]
  }
]

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

{
  "sucesso": true,
  "mensagem": "text",
  "resposta": [
    {
      "dados": {
        "rowguid": "text",
        "idCargo": 1,
        "grupoEtario": {
          "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
            }
          ]
        },
        "perfilSocioEconomico": [
          {
            "perfilCliente": 1,
            "tarifaLimite": 1,
            "planos": [
              {
                "tarifaReembolso": 1,
                "tarifaPlano": 1,
                "idPlano": 1,
                "nomePlano": "text",
                "idOperadora": 1,
                "nomeOperadora": "text",
                "id_tipo_modalidade": 1
              }
            ]
          }
        ],
        "planosCotacao": [
          {
            "idOperadora": 1,
            "operadora": "text",
            "tipoContrato": [
              {
                "tipo_precificacao": "text",
                "coparticipacao": "text",
                "planos": [
                  {
                    "idPlano": 1,
                    "plano": "text",
                    "valor": 1,
                    "planoPerfil": 1,
                    "id_tipo_modalidade": 1
                  }
                ]
              }
            ]
          }
        ],
        "planosCotacaoAdesao": [
          {
            "idOperadora": 1,
            "operadora": "text",
            "tipoContrato": [
              {
                "operadora": "text",
                "idOperadora": 1,
                "tipoContrato": "text",
                "descricaoEntidade": "text",
                "planos": [
                  {
                    "idPlano": 1,
                    "plano": "text",
                    "valor": 1,
                    "planoPerfil": 1,
                    "modalidade": 1
                  }
                ]
              }
            ]
          }
        ],
        "planosCotacaoOdonto": [
          {
            "idOperadora": 1,
            "operadora": "text",
            "tipoContrato": [
              {
                "operadora": "text",
                "idOperadora": 1,
                "tipoContrato": "text",
                "descricaoEntidade": "text",
                "planos": [
                  {
                    "idPlano": 1,
                    "plano": "text",
                    "valor": 1,
                    "planoPerfil": 1,
                    "modalidade": 1
                  }
                ]
              }
            ]
          }
        ],
        "operadoras": [
          1
        ]
      },
      "quantidade": 1
    }
  ]
}

Quarto Passo:

Com o response obtido no terceiro passo, o utilizaremos para montar o payload para o Serviço do Comparador. Dicionário de Payload para o Comparador:

Parametro	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 não utilizar abreviações.
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	(Id Oferta) Não obrigatório
operadoraPreferencial	(id operadora) 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 de Vidas
faixasAdicionais	Array ex: [{"faixa": 79, "vidas": 3}]

Em seguida com nosso payload pronto, usaremos o end point de comparação abaixo:

Api Comparador Saúde

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
  }
}

Links Úteis:

3KB

PostmanCollectionGnesys.json

Open

Biblioteca do Postman