Pular para o conteúdo principal

Apólice

A API Apólice permite a gestão de apólices, incluindo cadastro, consulta, atualização e remoção.

Swagger

NSConnect

GET /apolice​

Consulta apólices registradas.

Parâmetros​

  • terminal (query, opcional): Identificação do terminal.
  • cnpj (query, obrigatório): CNPJ vinculado.
  • Cis (query, opcional): Código de identificação da seguradora.
  • page (query, opcional, padrão: 1): Página da consulta.

Respostas​

  • 200 OK - Lista de apólices retornada com sucesso.
  • 401 Unauthorized - Falha na autenticação.

POST /apolice​

Cria uma nova apólice.

Corpo da Requisição (JSON)​

{
  "terminal": "string",
  "cnpj": "string",
  "ramo": "string",
  "numero": "string",
  "limite": 0,
  "inicio": "2025-04-10T06:35:18.806Z",
  "fim": "2025-04-10T06:35:18.806Z"
}

Respostas​

  • 200 OK - Apólice criada com sucesso.
  • 401 Unauthorized - Falha na autenticação.

GET /apolice/detalhes/{id}​

Obtém os detalhes de uma apólice específica.

Parâmetros​

  • id (path, obrigatório): Identificação da apólice.

Respostas​

  • 200 OK - Detalhes da apólice retornados com sucesso.
  • 401 Unauthorized - Falha na autenticação.

DELETE /apolice/{id}​

Remove uma apólice do sistema.

Parâmetros​

  • id (path, obrigatório): Identificação da apólice.

Respostas​

  • 200 OK - Apólice removida com sucesso.
  • 401 Unauthorized - Falha na autenticação.

PATCH /apolice/{id}​

Atualiza uma apólice existente.

Corpo da Requisição (JSON)​

{
  "numero": "string",
  "limite": 0,
  "inicio": "2025-04-10T06:35:18.815Z",
  "fim": "2025-04-10T06:35:18.815Z"
}

Respostas​

  • 200 OK - Apólice atualizada com sucesso.
  • 401 Unauthorized - Falha na autenticação.

Essa API é essencial para o gerenciamento eficiente das apólices de seguros.