/brokers
API para consultar os dados do corretor associado ao usuário
Objetivo
Esta API tem o objetivo de retornar toda a estrutura de dados do corretor por usuário.
O Resultado desta API trará a informação alinhada com o modelo de MarketPlace da HDI Seguros
Contrato de Serviço - Swagger
Download SwaggerCollection Test Postman
Download Collection Test
Dados Básicos
Nome do Serviço | /brokers Lista Corretor |
Descrição Resumida | Consulta os dados do corretor associado ao usuário. |
URL | Base Path: openapi.hdi.com.br/corporate/broker/v2 URI: /brokers |
Status | Ativo |
Versão | 2.0 |
Diagrama
Exemplo de Payload
key=AIzaSyA3cRm_CHBCT1c4adDRRUqkrchj_hyas-E
Content-Type=application/json
X-Company-Id=01
X-Application-Id=01
X-User-Id=7777777777
Authorization=Bearer token {{token}}
[
{
"code": "string",
"id": "number",
"name": "string",
"sucursalCode": "string",
"susepCode": "string",
"type": {
"description": "string",
"id": "number"
}
}
]
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 deve ser: Application/Json -
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: CPF do corretor
-- Saiba Mais[+]
Poderá ser usado o código do usuário ou o CPF ao autenticar no sistema -
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 renovado após 1 hora
-
-
Param
-
keyTipo: 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]
-
Parâmetros e Detalhes do Response
Caso o retorno for uma lista vazia [] com o status 200 pode significar que o Corretor está inativo, para maiores detalhes entrem em contato com a filial.
RESPONSE
- Header
- Body
- brokers[]
-
broker
-
codeTipo: String
Obrigatório: Sim
Descrição: Código de identificação do produtor
-- Saiba Mais[+]
Ex: 000000123 -
idTipo: Integer
Obrigatório: Sim
Descrição: Código de identificação do produtor sem os zeros a esquerda
-- Saiba Mais[+]
Ex: 123 (000000123) -
nameTipo: String
Obrigatório: Sim
Descrição: Nome do produtor
-- Saiba Mais[+]
Ex: Espaco Informatica -
sucursalCodeTipo: String
Obrigatório: Sim
Descrição: Código da sucursal
-- Saiba Mais[+]
Ex: 001 para SP ABC -
susepCodeTipo: String
Obrigatório: Sim
Descrição: Código Susep do corretor
-- Saiba Mais[+]
Ex: 00000000000001 -
type
-
descriptionTipo: String
Obrigatório: Sim
Descrição: Código do tipo do produtor
-- Saiba Mais[+]
Ex: A, C -
idTipo: String
Obrigatório: Sim
Descrição: Código de identificação do tipo do produtor
-- Saiba Mais[+]
Ex: 1
-
-
Informações de ambientes
## Homologação | ## https://openapi-int.hdi.com.br/corporate/broker/v2/brokers |
## Produção | ## https://openapi.hdi.com.br/corporate/broker/v2/brokers |
Histórico de versões
Autor | Área ou Setor | Versão | Descrição da versão |
---|---|---|---|
OpenInsurance | Open Insurance | V2.0 | Versão Inicial |