/compositions/questionaries
API para recuperação do código de autorização
Objetivo
A API de questionário visa retornar toda a lista de perguntas referente ao item e ao condutor, utilizados para a formação do calculo do prêmio.
Contrato de Serviço - Swagger
Download SwaggerCollection Test Postman
Download Collection TestDados Básicos
| Nome do Serviço | marketplace/offer/v1/components/compositions |
| Descrição Resumida | Retorno do questionário envolvido para a oferta, para que o cliente preencha os dados de risco do item e condutor |
| URL | Base Path: openapi.hdi.com.br/marketplace/offer/v1/components/compositions URI: /questionnaires |
| Status | Ativo |
| Versão | 1.0 |
Diagrama
Exemplo de Payload
componentId:1
postalCode:05777190
questionaryType:3
vehicleCategory:11
key:AIzaSyCwI4ocy8qCWOrhLSmLFAKkZpoIKqr7LBQ
X-Application-Id:1
X-Company-Id:1
X-User-Id:1
{
"compositions": [
{
"id": 2,
"code": "430",
"description": "HDI FIT",
"questionnaire": {
"questions": [
{
"id": 1,
"code": "001",
"description": "Faixa etaria do condutor",
"answers": [
{
"id": 1,
"code": "0101",
"description": "ATE 21 ANOS"
},
{
"id": 2,
"code": "0102",
"description": "IDADE ENTRE 22 E 25 ANOS"
},
{
"id": 3,
"code": "0103",
"description": "IDADE ENTRE 26 E 29 ANOS"
},
{
"id": 4,
"code": "0104",
"description": "IDADE ENTRE 30 E 32 ANOS"
},
{
"id": 5,
"code": "0105",
"description": "DE 33 A 36 ANOS"
},
{
"id": 6,
"code": "0106",
"description": "DE 37 A 38 ANOS"
},
{
"id": 7,
"code": "0107",
"description": "IDADE DE 39 A 42 ANOS"
},
{
"id": 8,
"code": "0108",
"description": "IDADE ENTRE 43 A 49 ANOS"
},
{
"id": 9,
"code": "0109",
"description": "IDADE ENTRE 50 A 54 ANOS"
},
{
"id": 10,
"code": "0110",
"description": "IDADE ENTRE 55 A 62 ANOS"
},
{
"id": 11,
"code": "0111",
"description": "IDADE ACIMA DE 63 ANOS"
}
]
},
{
"id": 2,
"code": "002",
"description": "Sexo",
"answers": [
{
"id": 12,
"code": "0201",
"description": "Feminino"
},
{
"id": 13,
"code": "0202",
"description": "Masculino"
}
]
},
{
"id": 3,
"code": "003",
"description": "Estado civil",
"answers": [
{
"id": 14,
"code": "0301",
"description": "Casado(a) e/ou residente com companheiro(a)"
},
{
"id": 15,
"code": "0302",
"description": "Solteiro(a)"
},
{
"id": 16,
"code": "0303",
"description": "Viuvo(a)"
},
{
"id": 17,
"code": "0304",
"description": "Divorciado(a)"
}
]
}
]
}
},
{
"id": 1,
"code": "431",
"description": "HDI AUTO PERFIL",
"questionnaire": {
"questions": [
{
"id": 1,
"code": "001",
"description": "Faixa etaria do condutor",
"answers": [
{
"id": 1,
"code": "0101",
"description": "ATE 21 ANOS"
},
{
"id": 2,
"code": "0102",
"description": "IDADE ENTRE 22 E 25 ANOS"
},
{
"id": 3,
"code": "0103",
"description": "IDADE ENTRE 26 E 29 ANOS"
},
{
"id": 4,
"code": "0104",
"description": "IDADE ENTRE 30 E 32 ANOS"
},
{
"id": 5,
"code": "0105",
"description": "DE 33 A 36 ANOS"
},
{
"id": 6,
"code": "0106",
"description": "DE 37 A 38 ANOS"
},
{
"id": 7,
"code": "0107",
"description": "IDADE DE 39 A 42 ANOS"
},
{
"id": 8,
"code": "0108",
"description": "IDADE ENTRE 43 A 49 ANOS"
},
{
"id": 9,
"code": "0109",
"description": "IDADE ENTRE 50 A 54 ANOS"
},
{
"id": 10,
"code": "0110",
"description": "IDADE ENTRE 55 A 62 ANOS"
},
{
"id": 11,
"code": "0111",
"description": "IDADE ACIMA DE 63 ANOS"
}
]
},
{
"id": 2,
"code": "002",
"description": "Sexo",
"answers": [
{
"id": 12,
"code": "0201",
"description": "Feminino"
},
{
"id": 13,
"code": "0202",
"description": "Masculino"
}
]
},
{
"id": 3,
"code": "003",
"description": "Estado civil",
"answers": [
{
"id": 14,
"code": "0301",
"description": "Casado(a) e/ou residente com companheiro(a)"
},
{
"id": 15,
"code": "0302",
"description": "Solteiro(a)"
},
{
"id": 16,
"code": "0303",
"description": "Viuvo(a)"
},
{
"id": 17,
"code": "0304",
"description": "Divorciado(a)"
}
]
}
]
}
},
{
"id": 3,
"code": "436",
"description": "HDI Flex",
"questionnaire": {
"questions": [
{
"id": 1,
"code": "001",
"description": "Faixa etaria do condutor",
"answers": [
{
"id": 1,
"code": "0101",
"description": "ATE 21 ANOS"
},
{
"id": 2,
"code": "0102",
"description": "IDADE ENTRE 22 E 25 ANOS"
},
{
"id": 3,
"code": "0103",
"description": "IDADE ENTRE 26 E 29 ANOS"
},
{
"id": 4,
"code": "0104",
"description": "IDADE ENTRE 30 E 32 ANOS"
},
{
"id": 5,
"code": "0105",
"description": "DE 33 A 36 ANOS"
},
{
"id": 6,
"code": "0106",
"description": "DE 37 A 38 ANOS"
},
{
"id": 7,
"code": "0107",
"description": "IDADE DE 39 A 42 ANOS"
},
{
"id": 8,
"code": "0108",
"description": "IDADE ENTRE 43 A 49 ANOS"
},
{
"id": 9,
"code": "0109",
"description": "IDADE ENTRE 50 A 54 ANOS"
},
{
"id": 10,
"code": "0110",
"description": "IDADE ENTRE 55 A 62 ANOS"
},
{
"id": 11,
"code": "0111",
"description": "IDADE ACIMA DE 63 ANOS"
}
]
},
{
"id": 2,
"code": "002",
"description": "Sexo",
"answers": [
{
"id": 12,
"code": "0201",
"description": "Feminino"
},
{
"id": 13,
"code": "0202",
"description": "Masculino"
}
]
},
{
"id": 3,
"code": "003",
"description": "Estado civil",
"answers": [
{
"id": 14,
"code": "0301",
"description": "Casado(a) e/ou residente com companheiro(a)"
},
{
"id": 15,
"code": "0302",
"description": "Solteiro(a)"
},
{
"id": 16,
"code": "0303",
"description": "Viuvo(a)"
},
{
"id": 17,
"code": "0304",
"description": "Divorciado(a)"
}
]
}
]
}
}
]
}
Parâmetros e Detalhes do Request
REQUEST
- Header
-
Content-TypeTipo: String
Obrigatório: Sim
Descrição: Tipo do conteúdo a ser trafegado no protocolo http
-- Saiba Mais[+]
Este conteúdo pode ser: Application/Json e em alguns casos já temos Application/PDF -
X-Company-idTipo: String
Obrigatório: Sim
Descrição: Código da empresa
-- Saiba Mais[+]
Deverá ser informado um número para a empresa, que posteriormente servirá para rastreio do consumo da API, por exemplo, este campo no recálculo, na proposta e nas consultas de cálculo e emissão deverão ser o mesmo da oferta inicial -
x-Application-idTipo: String
Obrigatório: Sim
Descrição: Código da aplicação
-- Saiba Mais[+]
Código recebido pela HDI para identificação da aplicação que está consumindo a API, se a API for utilizada por mais do que uma aplicação, informar a HDI para gerar um outro código, desta forma garantimos a unicidade das transações e conseguimos ter clareza nas produtividades de cada aplicação -
X-User-IdTipo: String
Obrigatório: Sim
Descrição: Código do Usuário
-- Saiba Mais[+]
Deverá ser informado o CPF do usuário vendedor no caso de seguros. Outros segmentos poderão ter o código do usuário a autenticar no sistema diferente do CPF -
AuthorizationTipo: String
Obrigatório: Sim
Descrição: Token de Autorização
-- Saiba Mais[+]
Deverá ser informado o code da API de Token, que deverá ser renovada após 1 hora
-
-
Param
-
keyTipo: String
Obrigatório: Sim
Descrição: chave de acesso única por player.
-- Saiba Mais[+]
E Esta chave é intransferível e garante a autorização para consumir as funcionalidades da HDI Seguros, ou seja, em todos as chamadas independente da API deverá ser trafegada esta chave nos Params.
Para obter acesso a chave é necessário passar por um processo de autorização junto a área de parcerias da HDI Seguros. O canal para solicitar acesso é através do e-mail: [email protected] -
componentIdTipo: String
Obrigatório: Sim
Descrição: Id do componente
-- Saiba Mais[+]
ID do componente, obtido na API de Portfólio -
questionaryTypeTipo: String
Obrigatório: Sim
Descrição: Código do tipo do questionário
-- Saiba Mais[+]
Deverá ser informado o tipo de questionário, 2 para item e 3 para condutor -
postalCodeTipo: String
Obrigatório: Sim
Descrição: CEP
-- Saiba Mais[+]
Quando for veículo, deverá ser informado o CEP de pernoite. -
vehicleCategoryTipo: String
Obrigatório: Sim
Descrição: Categoria do Modelo do veículo
-- Saiba Mais[+]
Código do modelo do veículo, obtido na API de SearchAuto. Ex: 10
-
Parâmetros e Detalhes do Response
RESPONSE
- Header
- Body
-
compositions[]
-
idTipo: Integer
Obrigatório: Sim
Descrição: Código de identificação do Produto
-- Saiba Mais[+]
Será ordenado as perguntas e respostas por produto. Ex: ID 1 - HDI AUTO PERFIL -
codeTipo: String
Obrigatório: Sim
Descrição: Código do Produto
-- Saiba Mais[+]
Ex: 431 -
descriptionTipo: String
Obrigatório: Sim
Descrição: Descrição da Produto
-- Saiba Mais[+]
Ex: HDI AUTO PERFIL -
questionnaire
-
questions[]
-
idTipo: Integer
Obrigatório: Sim
Descrição: Id da Identificação da questão
-- Saiba Mais[+]
Os Ids das perguntas deverão ser preenchidos na entrada das APIs de oferta e recálculo. Ex: 1 -
codeTipo: String
Obrigatório: Sim
Descrição: Código da Questão
-- Saiba Mais[+]
Ex: 001 -
descriptionTipo: String
Obrigatório: Sim
Descrição: Descrição da questão
-- Saiba Mais[+]
Ex: Faixa etaria do condutor -
answers[]
-
idTipo: Integer
Obrigatório: Sim
Descrição: Código da Identificação da resposta
-- Saiba Mais[+]
Os Ids das respostas deverão ser preenchidos nas APIs de oferta e recálculo. Ex: 1
Se na pergunta “Utilização do veículo”, for respondido “Motorista Aplicativo (Exceto Táxi)”, não será possível a comercialização do produto HDI AUTO PERFIL, porém os produtos HDI FIT e HDI FLEX tem essa condição.
Caso nessa mesma pergunta, o cliente responda “Motorista de Táxi”, o produto HDI AUTO PERFIL poderá ser comercializado (Nessa situação a IS do veículo não poderá ser superior a 85%), já os produtos HDI FIT e HDI FLEX não tem essa condição. -
codeTipo: String
Obrigatório: Sim
Descrição: Código da Resposta
-- Saiba Mais[+]
Ex: 0101 -
descriptionTipo: String
Obrigatório: Sim
Descrição: Descrição da Resposta
-- Saiba Mais[+]
Ex: ATE 21 ANOS
-
-
-
questions[]
-
-
compositions[]
.
Informações de ambientes
Histórico de versões
| Autor | Área ou Setor | Versão | Descrição da versão |
|---|---|---|---|
| OpenInsurance | Integração | V1.0 | Versão Inicial |