ComeçarNossos ProdutosNossas APIsSolicitar Acesso

BUSCA PORTFÓLIO

/portfolio/viewAll API para recuperação de Portfólio de produtos do corretor (*)

Objetivo

Esta API tem o objetivo de retornar toda a estrutura de catálogo de ofertas.
O Resultado desta API trará a informação alinhada com o modelo de MarketPlace da HDI Seguros

Contrato de Serviço - Swagger
Download Swagger
Collection Test Postman
Download Collection Test
Dados Básicos
Nome do Serviço /marketplace/offer/v1
Descrição ResumidaProver informações da hierarquia do catálogo de ofertas market place da HDI.
URLBase Path:
openapi.hdi.com.br/marketplace/offer/v1

URI:
/portfolio/viewAll
StatusAtivo
Versão1.0
Diagrama
650
Exemplo de Payload
key={{API_KEY_PARCEIRO}}
limit:20
sucursalCode:000
susepCode:00000000000000

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

{
    "segment": [
        {
            "id": 1,
            "description": "INSURANCE",
            "components": [
                {
                    "id": 1,
                    "description": "AUTO",
                    "compositions": [
                        {
                            "id": 2,
                            "description": "HDI FIT"
                        },
                        {
                            "id": 4,
                            "description": "HDI DUO"
                        },
                        {
                            "id": 13,
                            "description": "HDI FUNCIONAL"
                        },
                        {
                            "id": 14,
                            "description": "HDI AUTO EMPRESA"
                        },
                        {
                            "id": 1,
                            "description": "HDI AUTO PERFIL"
                        },
                        {
                            "id": 3,
                            "description": "HDI AUTO BÁSICO"
                        },
                        {
                            "id": 11,
                            "description": "HDI Novo Perfilado"
                        },
                        {
                            "id": 20,
                            "description": "HDI AUTO"
                        }
                    ]
                }
            ]
        }
    ]
}
Parâmetros e Detalhes do Request
REQUEST
  • Header
    • Content-Type
      Tipo: 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-id
      Tipo: 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-id
      Tipo: 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-Id
      Tipo: 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
    • Authorization
      Tipo: String
      Obrigatório: Sim
      Descrição: Token de Autorização
      -- Saiba Mais
      [+]
      Deverá ser informado o code da API de Token, que deverá ser renovado após 1 hora
  • Param
    • key
      Tipo: String
      Obrigatório: Sim
      Descrição: chave de acesso única por player.
      -- Saiba Mais
      [+]
      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]
    • sucursalCode
      Tipo: String
      Obrigatório: Não
      Descrição: Código da Sucursal.
      -- Saiba Mais
      [+]
      Deverá ser informado o número da Sucursal do corretor. Nesse primeiro momento este campo não terá validação.
    • susepCode
      Tipo: String
      Obrigatório: Sim
      Descrição: Código da Susep
      -- Saiba Mais
      [+]
      Deverá ser informado o código da SUSEP para retornar os produtos disponíveis para comercialização do corretor
Parâmetros e Detalhes do Response
RESPONSE
  • Header
  • Body
    • segment[]
      • id
        Tipo: Integer
        Obrigatório: Sim
        Descrição: Código de identificação do segmento
        -- Saiba Mais
        [+]
        Ex: 1 para Insurance
      • description
        Tipo: String
        Obrigatório: Sim
        Descrição: Descrição do segmento
        -- Saiba Mais
        [+]
        Ex: INSURANCE
      • components[]
        • id
          Tipo: Integer
          Obrigatório: Sim
          Descrição: id do componente
          -- Saiba Mais
          [+]
          Ex: 1 - Auto, 2 - Patrimonial
        • description
          Tipo: String
          Obrigatório: Sim
          Descrição: Descrição do componente
          -- Saiba Mais
          [+]
          Ex: 1 - Auto, 2 - Patrimonial
        • compositions[]
          • id
            Tipo: Integer
            Obrigatório: Sim
            Descrição: id do composition
            -- Saiba Mais
            [+]
            Ex: 1 - HDI Auto Perfil
          • description
            Tipo: String
            Obrigatório: Sim
            Descrição: Descrição do composition
            -- Saiba Mais
            [+]
            Ex: HDI AUTO PERFIL

.

Informações de ambientes
## Homologação## https://openapi-int.hdi.com.br/marketplace/offer/v1/portfolio/viewAll
## Produção## https://openapi.hdi.com.br/marketplace/offer/v1/portfolio/viewAll
Histórico de versões
AutorÁrea ou SetorVersãoDescrição da versão
OpenInsuranceIntegraçãoV1.0Versão Inicial