跳到主要内容

Início

O Catálogo de Produtos é a superfície de descoberta do Insurance-as-a-Service: ele responde "o que a minha integração pode vender?" e "como monto uma seleção válida para cotar?". São dois endpoints somente de leitura, escopados aos produtos habilitados para a sua integração.

Conceitos

ConceitoDescrição
Produto (product)Um produto de seguro de uma seguradora parceira (ex.: um prestamista, um seguro de vida em grupo). É a unidade de venda: cada produto vendido em um pedido gera uma apólice. Endereçado por product_key.
Cobertura (service)Uma cobertura ou benefício que compõe o produto (ex.: morte, invalidez por acidente, assistência funeral). Pode ser obrigatória (mandatory) ou opcional. Endereçada por service_key.
Espaço de opçõesOs limites configuráveis de cada cobertura: importância segurada máxima (maximum_insured_amount) e os envelopes tipados de franquia (deductible_options) e carência (waiting_period_options) aceitos. Uma seleção fora do espaço de opções é rejeitada na cotação.
DependênciasRegras estruturais entre coberturas do mesmo produto: include (coberturas pré-requisito) e exclude (coberturas mutuamente exclusivas).
Faixa de comissão (commission_bounds)A banda {minimum_rate, maximum_rate, default_rate} da sua comissão por venda daquele produto. A comissão enviada na cotação e no pedido (commission_data) é validada contra essa faixa; se omitida, vale o default_rate.
Configuração padrão (default_configuration)Valores padrão de cobertura configurados para a sua integração. Quando a seleção omite a lista services, a cotação preenche automaticamente todas as coberturas padrão configuradas.

Classificação dos produtos

Cada produto carrega uma classificação regulatória e comercial:

CampoDescrição
product_categoryinsurance, capitalization ou benefit. Um produto pode combinar coberturas de categorias diferentes (ex.: seguro + assistência).
insurance_classO ramo SUSEP do produto (ex.: credit_life). Ausente para produtos não-seguro. Na cotação e no pedido, o ramo é retornado como objeto { name, class_number, group_number }.
regulator_registrationO registro do produto na SUSEP (Código SUSEP).

Visibilidade e confidencialidade

  • Somente produtos ativos habilitados para a sua integração são visíveis; um produto de outro parceiro (ou inexistente) retorna 404.
  • A faixa de comissão retornada é sempre a sua — nunca a de outro parceiro.
  • As regras internas de tarifação e elegibilidade da seguradora não são expostas: você recebe os limites estruturais (espaço de opções e dependências) e o resultado da avaliação na cotação.

Endpoints

EndpointDescrição
GET /v1/product_catalog/productsLista os produtos que a sua integração pode vender.
GET /v1/product_catalog/products/{product_key}Detalha um produto: coberturas, espaço de opções, dependências, seus padrões e sua faixa de comissão.