API docs by Redocly

iBooster API (3.0.0)

Download OpenAPI specification:Download

Kalkulacje

Zestaw metod pozwalający na pracę nad kalkulacją

Zleca wykonanie kalkulacji dla zestawu danych

header Parameters
x-credentials-id
string
authorization
required
string
Request Body schema: application/json
required
object
Default: {}

Zestaw stałych zgód użytkownika, np. zgoda na przetwarzanie danych

cepikId
string

ID pojazdu w bazie CEPiK (Centralna Ewidencja Pojazdów i Kierowców)

required
object

Oczekiwania od oferty

required
Array of objects non-empty

Tablica zawierająca obiekty typu: osoba fizyczna, firma lub osoba prowadząca działalność gospodarczą

insurerDifferentThanPrimaryInsured
required
boolean

Czy ubezpieczony inny niż ubezpieczający?

isLeasing
required
boolean

Czy pojazd wzięty w leasing?

isAssignment
required
boolean

Czy jest cesja na bank?

Array of objects

Lista zgód udzielonych przez użytkownika, zawierająca szczegóły dotyczące każdej zgody

required
Array of objects = 1 items

Lista szczegółów dotyczących pojazdów użytkownika

object

Dane dotyczące bieżącej promocji, jeśli dotyczy

Responses

Request samples

Content type
application/json
{
  • "staticConsents": { },
  • "cepikId": "string",
  • "expectations": {
    },
  • "subjectList": [
    ],
  • "insurerDifferentThanPrimaryInsured": true,
  • "isLeasing": true,
  • "isAssignment": true,
  • "consentList": [
    ],
  • "vehicleDetailList": [
    ],
  • "promotion": {
    }
}

Response samples

Content type
application/json
{
  • "calculationId": "string",
  • "insurerCalculationId": "string",
  • "clientAccessConfigId": "string",
  • "status": "pending",
  • "externalUserId": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "payload": {
    },
  • "insuranceStartDate": "string",
  • "insuranceEndDate": "string",
  • "vehicleDetailList": [
    ]
}

Zwraca stan kalkulacji

path Parameters
calculationId
required
string

ID kalkulacji

Responses

Response samples

Content type
application/json
{
  • "calculationId": "string",
  • "proposalList": [
    ],
  • "offerList": [
    ],
  • "policyList": [
    ]
}

Propozycje

Zestaw metod pozwalający na pracę nad propozycjami

/api/v3/calculations/{calculationId}/tasks/{proposalId}

path Parameters
calculationId
required
string

ID kalkulacji, pozwala na jednoznaczną identyfikację wybranej kalkulacji

proposalId
required
string

ID oferty, umożliwia powiązanie z określoną ofertą

Responses

Response samples

Content type
application/json
{
  • "proposal": {
    }
}

/api/v3/proposal/{proposalId}

path Parameters
proposalId
required
string
Request Body schema: application/json
Array of objects

Lista zgód zaakceptowanych przez użytkownika, jeśli dotyczy.

Array of objects

Lista podmiotów (osób lub firm) powiązanych z propozycją.

Array of objects

Lista pojazdów powiązanych z propozycją, jeśli dotyczy.

Responses

Request samples

Content type
application/json
{
  • "consentList": [
    ],
  • "subjectList": [
    ],
  • "vehicleList": [
    ]
}

Response samples

Content type
application/json
{
  • "proposal": {
    }
}

Oferty

Zestaw metod pozwalający na pracę nad ofertami

/api/v3/offers/{offerId}

path Parameters
offerId
required
string

Unikalny identyfikator oferty. Jest to ciąg znaków reprezentujący ID oferty, który pozwala zidentyfikować daną ofertę w systemie.

Responses

Response samples

Content type
application/json
{
  • "offer": {
    }
}

/api/v3/offers

Request Body schema: application/json
proposalId
required
string
Array of objects

Responses

Request samples

Content type
application/json
{
  • "proposalId": "string",
  • "consentList": [
    ]
}

Response samples

Content type
application/json
{
  • "offerId": "42da58f8-9040-4cf5-98ce-bce9965cca0d"
}

Polisy

Zestaw metod służących do polisowania oferty

/api/v3/policies/{policyId}

path Parameters
policyId
required
string

Unikalny identyfikator polisy, który pozwala na jednoznaczną identyfikację danej polisy ubezpieczeniowej w systemie.

Responses

Response samples

Content type
application/json
{
  • "policy": {
    }
}

/api/v3/policies

Request Body schema: application/json
offerId
required
string

Unikalny identyfikator oferty, który pozwala na jednoznaczną identyfikację oferty w systemie.

paidAmount
number

Kwota zapłacona przez klienta za ofertę, jeśli jest dostępna.

Array of objects

Lista zgód zaakceptowanych przez użytkownika, jeśli dotyczy.

Responses

Request samples

Content type
application/json
{
  • "offerId": "string",
  • "paidAmount": 0,
  • "consentList": [
    ]
}

Response samples

Content type
application/json
{
  • "policyId": "67514316-9f8e-4b10-9dc8-182936c6135a"
}

/api/v3/policies/activate

Request Body schema: application/json
policyId
required
string
paidAmount
required
number

Request samples

Content type
application/json
{
  • "policyId": "string",
  • "paidAmount": 0
}

Dodatkowe

/api/v3/cepik

header Parameters
x-credentials-id
string
authorization
required
string
Request Body schema: application/json
insurerBrandNameList
required
Array of strings non-empty
Items Enum: "trasti" "link4" "uniqa" "mtu24" "interrisk" "hestia" "tuz" "youCanDrive"
registrationNumber
required
string

Numer rejestracyjny pojazdu. Przykład: 'KR12345'.

dateOfBirth
string

Data urodzenia właściciela pojazdu w formacie yyyy-MM-dd.

pesel
string

Numer PESEL osoby, opcjonalnie, jeśli dotyczy właściciela pojazdu.

startDate
string

Data rozpoczęcia ubezpieczenia w formacie YYYY-MM-DD.

Request samples

Content type
application/json
{
  • "insurerBrandNameList": [
    ],
  • "registrationNumber": "KR12345",
  • "dateOfBirth": "1985-05-20",
  • "pesel": "85052012345",
  • "startDate": "2024-01-01"
}

/api/v3/cepik/{cepikId}

path Parameters
cepikId
required
string

/api/v3/dictionary/infoekspert/publicNumber/{publicNumber}

path Parameters
publicNumber
required
string

/api/v3/dictionary/{dictionaryType}/modelId/{modelId}

path Parameters
required
string or string
modelId
required
string

/api/v3/dictionary/{dictionaryType}/*

path Parameters
required
string or string

Systemowe

/health-check

Autoryzacja

/internal/credentials/{credentialsToken}

path Parameters
credentialsToken
required
string

/api/v3/credentials

Request Body schema: application/json
object
object
object
object
link4
object
uniqa
object
tuz
object
interrisk
object

Request samples

Content type
application/json
{
  • "youCanDrive": {
    },
  • "hestia": {
    },
  • "mtu24": {
    },
  • "trasti": {
    },
  • "link4": { },
  • "uniqa": { },
  • "tuz": { },
  • "interrisk": { }
}

/api/v3/credentials/{credentialsId}

path Parameters
credentialsId
required
string
Request Body schema: application/json
object
object
object
object
link4
object
uniqa
object
tuz
object
interrisk
object

Request samples

Content type
application/json
{
  • "youCanDrive": {
    },
  • "hestia": {
    },
  • "mtu24": {
    },
  • "trasti": {
    },
  • "link4": { },
  • "uniqa": { },
  • "tuz": { },
  • "interrisk": { }
}

/api/v3/realms/{realm}/token

path Parameters
realm
required
string
Request Body schema: application/json
clientId
required
string
externalUserId
required
string
grantType
required
string
Value: "client_credentials"
clientSecret
required
string

Request samples

Content type
application/json
{
  • "clientId": "string",
  • "externalUserId": "string",
  • "grantType": "client_credentials",
  • "clientSecret": "string"
}