/offers
API para recuperação do código de autorização
Objetivo
Disponibilizar um serviço que realize ofertas disponiveis no catalogo, com base nos atributos informados.
Contrato de Serviço - Swagger
Download SwaggerCollection Test Postman
Download Collection TestDados Básicos
Nome do Serviço | API Oferta |
Descrição Resumida | Listar ofertas com base no catalogo |
URL | Base Path: /marketplace/offer/v1/ URI: 1) /offers |
Status | Ativo |
Versão | 1.0 |
Diagrama
Exemplo de Payload
key=AIzaSyCS3yeMs9pYI7BPIy4Cg_d1wcKoW1AIe5Q
Content-Type=application/json
X-Company-Id=01
X-Application-Id=01
X-User-Id=01
Authorization=Bearer eyJraWQiOiJiZDc2MzhjYzg4OTU2ZmNjZGFhMGRlYWQ2NDk5M2E1NjQ0ZTcwMTVkIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJoZGktY29ycG9yYXRlLWF1dGhAaW5zLWNyb3NzLXNlY3VyaXR5LWF1dGgtaW50Zy5pYW0uZ3NlcnZpY2VhY2NvdW50LmNvbSIsImF1ZCI6ImFwaS5oZGkuY29tLmJyIiwiYXBwbGljYXRpb24iOltudWxsXSwicm9sZXMiOlsiUm9sZTEiLCJSb2xlMiIsIlJvbGVOIl0sImlzcyI6ImhkaS1jb3Jwb3JhdGUtYXV0aEBpbnMtY3Jvc3Mtc2VjdXJpdHktYXV0aC1pbnRnLmlhbS5nc2VydmljZWFjY291bnQuY29tIiwiZXhwIjoxNTcyNDc4NDY4LCJpYXQiOjE1NzI0NzQ4NjgsInVzZXIiOlsiYXBpLWlucy1pbnRlZ3JhdGlvbi1pbnRlcm5hbC1hY2Nlc3MiXSwid2ViQ2xpZW50IjpbbnVsbF19.N0KeFZzNZiUToV0-Y3hA15PYaYzAUq4xSjbErA97FUhp3Mqs1Yg2AByIOhcqWG4qIuEqvSuf1dIH0QdIToVySP4db9fGEELqu48SF1yCwk2fuaxGLmRtgNDjoJRPwkrxFDUSR7MMsnxn9pV2_sevaWJCyF7QKdGMG0zgZVQbb25S7IrOD3CF97fN9PN5yhsj9f3C8_WDqbDRsvVUdMItmmsbQI98iWM4xQ7O93s1TQCcd84ZQhOdBfYw_yY6jz-hA-tYin3vS33DIcAAR-HNnljdV_9XmWQ5WXd07VjCI8Ynntlrb3vyYjgbkl15VMvfsm0p2ZXgm5jLKFdw8w5nyg
{
"prospect":{
"name":"TESTE",
"socialName":"TESTE",
"documents":[
{
"type":{
"id":1
},
"number":"38277497008"
}
],
"contacts":[
{
"type":{
"id":3
},
"data":"[email protected]",
"isAllowCampaign":true
}
],
"addresses":[
{
"street":"Rua ",
"district":"Vila ",
"number":781,
"complement":"casa",
"referencePoint":"padaria da cidade",
"postalCode":"00000000"
}
]
},
"search":{
"segment":[
{
"id":"1",
"components":[
{
"id":"1",
"compositions":[
{
"id":"1"
}
]
}
]
}
],
"businessItem":{
"insurance":{
"period":{
"effectiveDate":"2019-10-29",
"expirationDate":"2020-10-29"
},
"installmentDay":30,
"brokers":[
{
"sucursalCode":"000",
"susepCode":"00000000000000",
"isMain":true,
"percentageCommission":15,
"percentageParticipation":100
}
],
"autos":[
{
"fipePercentage":100,
"isNewVehicle":false,
"circulationPostalCode":"00000000",
"overnightPostalCode":"00000000",
"insuranceRelationship":{
"claimQuantity":0,
"bonusClassNumber":2,
"previousPolicy":{
"counterpartCode":"5177",
"code":"",
"expirationDate":"2019-10-26"
}
},
"vehicle":{
"chassisCode":"HSADHSFDHSARJHJ",
"manufactureYear":2014,
"model":{
"id":15239,
"year":2014,
"fuelType":{
"id":1,
"description":"Gasolina"
}
}
},
"drivers":[
{
"name":"TESTE",
"socialName":"TESTE",
"document":{
"type":{
"id":1
},
"number":"38277497008"
},
"dateOfBirth":"1980-06-10",
"questionnaires":[
{
"questionId":"1",
"answerId":"4"
},
{
"questionId":"2",
"answerId":"12"
},
{
"questionId":"3",
"answerId":"14"
}
]
}
],
"coverages":[
{
"id":"3",
"deductibleID":5,
"guarantees":[
{
"id":"4",
"isValue":{
"amount":1000,
"currency":"BRL"
}
},
{
"id":"1",
"isValue":{
"amount":10000,
"currency":"BRL"
}
},
{
"id":"2",
"isValue":{
"amount":10000,
"currency":"BRL"
}
},
{
"id":"55",
"isValue":{
"amount":100000,
"currency":"BRL"
}
},
{
"id":"56",
"isValue":{
"amount":100000,
"currency":"BRL"
}
}
],
"additionals":[
{
"id":"57"
},
{
"id":"18"
},
{
"id":"19"
},
{
"id":"32"
}
],
"accessories":[
],
"protections":[
]
}
],
"questionnaires":[
{
"questionId":"8",
"answerId":"49"
},
{
"questionId":"13",
"answerId":"47"
},
{
"questionId":"9",
"answerId":"43"
}
]
}
]
}
}
}
}
{
"offers":[
{
"id":"aa962939-4832-4216-b285-be0bcbaa201e",
"name":"Oferta de Seguro",
"description":"Oferta de Seguro Auto",
"campaignImageCode":"",
"totalPrice":{
"amount":1426.26,
"currency":"R$",
"amountFormatted":"R$ 1.426,26"
},
"isOfferHighlighted":true,
"items":[
{
"code":"1",
"name":"Oferta de Seguro Auto",
"segment":[
{
"id":"ee17c083-b9ef-4274-bc55-7860b1a8fa1c",
"code":"1",
"description":"INSURANCE",
"components":[
{
"id":"6daf916c-5627-4bd5-995a-e727a69b5138",
"code":"1",
"description":"AUTO",
"compositions":[
{
"id":"a6b763ef-a866-46d0-99f0-3c6e66db8fbd",
"code":"1",
"description":"HDI AUTO PERFIL"
}
]
}
]
}
],
"insurance":{
"quotationId":"193231625",
"quotationDate":"2019-10-30",
"quotationExpirationDate":"2019-11-03",
"period":{
"effectiveDate":"2019-10-29",
"expirationDate":"2020-10-29"
},
"brokers":[
{
"sucursalCode":"000",
"susepCode":"00000000000000",
"isMain":true,
"percentageCommission":15,
"percentageParticipation":100,
"internalCode":null,
"brokerTypeCode":null
}
],
"items":[
{
"coverages":[
{
"id":3,
"code":"05",
"description":"Valor de Mercado Referenciado",
"deductibleID":5,
"deductibleDescription":"REDUZIDA",
"branchCode":"31",
"branchDescription":"Autom�vel - Casco",
"guarantees":[
{
"id":1,
"code":"1",
"description":"MORTE",
"isValue":{
"amount":10000.00,
"currency":"R$",
"amountFormatted":"R$ 10.000,00"
},
"netPremium":{
"amount":34.60,
"currency":"R$",
"amountFormatted":"R$ 34,60"
},
"deductible":{
"amount":0.00,
"currency":"R$",
"amountFormatted":"R$ 0,00"
}
},
{
"id":2,
"code":"2",
"description":"INVALIDEZ PERMANENTE",
"isValue":{
"amount":10000.00,
"currency":"R$",
"amountFormatted":"R$ 10.000,00"
},
"netPremium":{
"amount":18.56,
"currency":"R$",
"amountFormatted":"R$ 18,56"
},
"deductible":{
"amount":0.00,
"currency":"R$",
"amountFormatted":"R$ 0,00"
}
},
{
"id":4,
"code":"1",
"description":"CASCO",
"isValue":{
"amount":0.00,
"currency":"R$",
"amountFormatted":"R$ "
},
"netPremium":{
"amount":502.24,
"currency":"R$",
"amountFormatted":"R$ 502,24"
},
"deductible":{
"amount":1777.23,
"currency":"R$",
"amountFormatted":"R$ 1.777,23"
}
},
{
"id":55,
"code":"1",
"description":"DANOS MATERIAIS",
"isValue":{
"amount":100000.00,
"currency":"R$",
"amountFormatted":"R$ 100.000,00"
},
"netPremium":{
"amount":147.45,
"currency":"R$",
"amountFormatted":"R$ 147,45"
},
"deductible":{
"amount":0.00,
"currency":"R$",
"amountFormatted":"R$ 0,00"
}
},
{
"id":56,
"code":"2",
"description":"DANOS CORPORAIS",
"isValue":{
"amount":100000.00,
"currency":"R$",
"amountFormatted":"R$ 100.000,00"
},
"netPremium":{
"amount":74.70,
"currency":"R$",
"amountFormatted":"R$ 74,70"
},
"deductible":{
"amount":0.00,
"currency":"R$",
"amountFormatted":"R$ 0,00"
}
}
],
"additionals":[
{
"id":32,
"code":"0121",
"description":"Guincho Sem Limite de KM + 15 Dias Carro Reserva",
"maximumIndemnityLimits":{
"amount":11150.00,
"currency":"R$",
"amountFormatted":"R$ 11.150,00"
},
"premiumValue":{
"amount":291.66,
"currency":"R$",
"amountFormatted":"R$ 291,66"
},
"deductibleValue":{
"amount":0.00,
"currency":"R$",
"amountFormatted":"R$ 0,00"
}
},
{
"id":19,
"code":"0019",
"description":"Lanternas, Retrv ext e Far�is",
"maximumIndemnityLimits":{
"amount":1780.00,
"currency":"R$",
"amountFormatted":"R$ 1.780,00"
},
"premiumValue":{
"amount":68.75,
"currency":"R$",
"amountFormatted":"R$ 68,75"
},
"deductibleValue":{
"amount":0.00,
"currency":"R$",
"amountFormatted":"R$ 0,00"
}
},
{
"id":18,
"code":"0017",
"description":"HDI Auto Vidros",
"maximumIndemnityLimits":{
"amount":740.00,
"currency":"R$",
"amountFormatted":"R$ 740,00"
},
"premiumValue":{
"amount":70.41,
"currency":"R$",
"amountFormatted":"R$ 70,41"
},
"deductibleValue":{
"amount":0.00,
"currency":"R$",
"amountFormatted":"R$ 0,00"
}
},
{
"id":57,
"code":"0041",
"description":"Danos Morais",
"maximumIndemnityLimits":{
"amount":40000.00,
"currency":"R$",
"amountFormatted":"R$ 40.000,00"
},
"premiumValue":{
"amount":36.50,
"currency":"R$",
"amountFormatted":"R$ 36,50"
},
"deductibleValue":{
"amount":0.00,
"currency":"R$",
"amountFormatted":"R$ 0,00"
}
}
],
"accessories":null,
"protections":null,
"maximumIndemnityLimits":null
}
],
"questionnaires":[
{
"question":{
"id":8,
"description":"Guarda do veiculo"
},
"answer":{
"id":49,
"description":"Na residência e local de trabalho"
}
},
{
"question":{
"id":9,
"description":"Utilizacao do veiculo"
},
"answer":{
"id":43,
"description":"Exclusivamente para locomocao diaria"
}
},
{
"question":{
"id":13,
"description":"Deseja estender a cobertura para condutor entre 17 a 24 anos"
},
"answer":{
"id":47,
"description":"Sim"
}
}
],
"auto":{
"fipePercentageUsed":100.00,
"vehicle":{
"chassisCode":"",
"manufactureYear":2014,
"model":{
"id":15239,
"year":2014,
"fuelType":{
"id":1,
"description":"Gasolina"
},
"description":"FOX 1.6MI TOTAL FLEX 8V 5P",
"fipeCode":"005306-6",
"seatingCapacity":5,
"isInsurable":false,
"brand":{
"description":"VOLKSWAGEN"
}
},
"plateCode":"",
"age":5
},
"drivers":[
{
"name":"JAQUELINE LÍVIA ROCHA",
"socialName":"JAQUELINE LÍVIA ROCHA",
"document":{
"type":{
"id":1,
"description":"CPF"
},
"number":"03447085860"
},
"dateOfBirth":"2080-06-10",
"questionnaires":[
{
"question":{
"id":1,
"description":"Faixa etaria do condutor"
},
"answer":{
"id":7,
"description":"IDADE DE 39 A 42 ANOS"
}
},
{
"question":{
"id":2,
"description":"Sexo"
},
"answer":{
"id":12,
"description":"Feminino"
}
},
{
"question":{
"id":3,
"description":"Estado civil"
},
"answer":{
"id":14,
"description":"Casado(a) e/ou residente com companheiro(a)"
}
}
]
}
]
},
"deductibleValue":{
"amount":1777.24,
"currency":"R$",
"amountFormatted":"R$ 1.777,24"
},
"totalNetPremium":{
"amount":1328.23,
"currency":"R$",
"amountFormatted":"R$ 1.328,23"
},
"property":null
}
],
"totalGrossPremium":{
"amount":1426.25,
"currency":"R$",
"amountFormatted":"R$ 1,426.25"
},
"cost":{
"amount":0.00,
"currency":"R$",
"amountFormatted":"R$ 0,00"
},
"totalIof":{
"amount":98.02,
"currency":"R$",
"amountFormatted":"R$ 98,02"
},
"total":{
"amount":1426.26,
"currency":"R$",
"amountFormatted":"R$ 1.426,26"
},
"installments":[
{
"quantity":1,
"price":{
"amount":1426.26,
"currency":"R$",
"amountFormatted":"R$ 1.426,26"
},
"billingType":{
"id":2,
"description":"Débito em Conta"
}
},
{
"quantity":1,
"price":{
"amount":1426.26,
"currency":"R$",
"amountFormatted":"R$ 1.426,26"
},
"billingType":{
"id":2,
"description":"Débito em Conta"
}
},
{
"quantity":1,
"price":{
"amount":1426.26,
"currency":"R$",
"amountFormatted":"R$ 1.426,26"
},
"billingType":{
"id":3,
"description":"Carnê"
}
},
{
"quantity":10,
"price":{
"amount":172.49,
"currency":"R$",
"amountFormatted":"R$ 172,49"
},
"billingType":{
"id":2,
"description":"Débito em Conta"
}
},
{
"quantity":10,
"price":{
"amount":172.49,
"currency":"R$",
"amountFormatted":"R$ 172,49"
},
"billingType":{
"id":2,
"description":"Débito em Conta"
}
},
{
"quantity":10,
"price":{
"amount":172.49,
"currency":"R$",
"amountFormatted":"R$ 172,49"
},
"billingType":{
"id":3,
"description":"Carnê"
}
},
{
"quantity":2,
"price":{
"amount":713.13,
"currency":"R$",
"amountFormatted":"R$ 713,13"
},
"billingType":{
"id":2,
"description":"Débito em Conta"
}
},
{
"quantity":2,
"price":{
"amount":713.13,
"currency":"R$",
"amountFormatted":"R$ 713,13"
},
"billingType":{
"id":2,
"description":"Débito em Conta"
}
},
{
"quantity":2,
"price":{
"amount":728.96,
"currency":"R$",
"amountFormatted":"R$ 728,96"
},
"billingType":{
"id":3,
"description":"Carnê"
}
},
{
"quantity":3,
"price":{
"amount":475.42,
"currency":"R$",
"amountFormatted":"R$ 475,42"
},
"billingType":{
"id":2,
"description":"Débito em Conta"
}
},
{
"quantity":3,
"price":{
"amount":475.42,
"currency":"R$",
"amountFormatted":"R$ 475,42"
},
"billingType":{
"id":2,
"description":"Débito em Conta"
}
},
{
"quantity":3,
"price":{
"amount":496.48,
"currency":"R$",
"amountFormatted":"R$ 496,48"
},
"billingType":{
"id":3,
"description":"Carnê"
}
},
{
"quantity":4,
"price":{
"amount":356.56,
"currency":"R$",
"amountFormatted":"R$ 356,56"
},
"billingType":{
"id":2,
"description":"Débito em Conta"
}
},
{
"quantity":4,
"price":{
"amount":356.56,
"currency":"R$",
"amountFormatted":"R$ 356,56"
},
"billingType":{
"id":2,
"description":"Débito em Conta"
}
},
{
"quantity":4,
"price":{
"amount":380.45,
"currency":"R$",
"amountFormatted":"R$ 380,45"
},
"billingType":{
"id":3,
"description":"Carnê"
}
},
{
"quantity":5,
"price":{
"amount":285.25,
"currency":"R$",
"amountFormatted":"R$ 285,25"
},
"billingType":{
"id":2,
"description":"Débito em Conta"
}
},
{
"quantity":5,
"price":{
"amount":285.25,
"currency":"R$",
"amountFormatted":"R$ 285,25"
},
"billingType":{
"id":2,
"description":"Débito em Conta"
}
},
{
"quantity":5,
"price":{
"amount":310.89,
"currency":"R$",
"amountFormatted":"R$ 310,89"
},
"billingType":{
"id":3,
"description":"Carnê"
}
},
{
"quantity":6,
"price":{
"amount":237.71,
"currency":"R$",
"amountFormatted":"R$ 237,71"
},
"billingType":{
"id":2,
"description":"Débito em Conta"
}
},
{
"quantity":6,
"price":{
"amount":237.71,
"currency":"R$",
"amountFormatted":"R$ 237,71"
},
"billingType":{
"id":2,
"description":"Débito em Conta"
}
},
{
"quantity":6,
"price":{
"amount":264.61,
"currency":"R$",
"amountFormatted":"R$ 264,61"
},
"billingType":{
"id":3,
"description":"Carnê"
}
},
{
"quantity":7,
"price":{
"amount":231.62,
"currency":"R$",
"amountFormatted":"R$ 231,62"
},
"billingType":{
"id":2,
"description":"Débito em Conta"
}
},
{
"quantity":7,
"price":{
"amount":231.62,
"currency":"R$",
"amountFormatted":"R$ 231,62"
},
"billingType":{
"id":2,
"description":"Débito em Conta"
}
},
{
"quantity":7,
"price":{
"amount":231.62,
"currency":"R$",
"amountFormatted":"R$ 231,62"
},
"billingType":{
"id":3,
"description":"Carnê"
}
},
{
"quantity":8,
"price":{
"amount":206.91,
"currency":"R$",
"amountFormatted":"R$ 206,91"
},
"billingType":{
"id":2,
"description":"Débito em Conta"
}
},
{
"quantity":8,
"price":{
"amount":206.91,
"currency":"R$",
"amountFormatted":"R$ 206,91"
},
"billingType":{
"id":2,
"description":"Débito em Conta"
}
},
{
"quantity":8,
"price":{
"amount":206.91,
"currency":"R$",
"amountFormatted":"R$ 206,91"
},
"billingType":{
"id":3,
"description":"Carnê"
}
},
{
"quantity":9,
"price":{
"amount":187.77,
"currency":"R$",
"amountFormatted":"R$ 187,77"
},
"billingType":{
"id":2,
"description":"Débito em Conta"
}
},
{
"quantity":9,
"price":{
"amount":187.77,
"currency":"R$",
"amountFormatted":"R$ 187,77"
},
"billingType":{
"id":2,
"description":"Débito em Conta"
}
},
{
"quantity":9,
"price":{
"amount":187.77,
"currency":"R$",
"amountFormatted":"R$ 187,77"
},
"billingType":{
"id":3,
"description":"Carnê"
}
}
]
}
}
]
}
]
}
Parâmetros do Request Headers
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[+]
Código da empresa -
x-Application-idTipo: String
Obrigatório: Sim
Descrição: Código da aplicação
-- Saiba Mais[+]
Código da aplicação que irá consumir a API -
X-User-IdTipo: String
Obrigatório: Sim
Descrição: Código do Usuário
-- Saiba Mais[+]
Código do usuário autenticado no sistema que irá consumir a API
Representado por exemplo pelo CPF do corretor (no caso de seguros) -
X-Susep-CodeTipo: String
Obrigatório: Sim
Descrição: Código Susep do usuário para usar a API
X-Sucursal-CodeTipo: String
Obrigatório: Sim
Descrição: Código Sucursal do usuário para usar a API
X-Trace-IdTipo: String
Obrigatório: Sim
Descrição: Código Trace ID
- Params
-
keyTipo: String
Obrigatório: Sim
Descrição: chave de acesso única por player.
-- Saiba Mais[+]
Este conteúdo pode ser: Application/Json e em alguns casos já temos Application/PDF
Dúvidas GeraisCenários de TestesInformações de ambientes## Homologação ## https://openapi-int.hdi.com.br/marketplace/offer/v1/offers ## Produção ## https://openapi.hdi.com.br/marketplace/offer/v1/offers Histórico de versõesAutor Área ou Setor Versão Descrição da versão OpenInsurance Integração V1.0 Versão Inicial Observações de NegócioO retorno do valor máximo que poderá ser aplicado na conta corrente depende do aceite do termo de adesão por parte do corretor e se teve valor elegível para aplicação na cotação, sendo que o valor será retornado no objeto checkingAccount.limitAmount.amount. Caso o usuário queira aplicar algum valor, é necessário requisitar o serviço de "Aplicação da Conta Corrente".
-