Dokumentacja API

Przegląd

To REST API umożliwia tworzenie, odczyt, edycję i usuwanie monitorowanych podmiotów Twojego konta oraz wyświetlanie powiązanych zdarzeń monitorowania. Wszystkie endpointy zwracają JSON i wymagają uwierzytelnienia.

Bazowy URL: /api
Format: application/json

Uwierzytelnianie

Każde żądanie musi zawierać ważny token API wydany dla Twojego konta. Wyślij go w nagłówku Authorization w schemacie Bearer.

Nagłówek

Authorization: Bearer {api_token}

Tokeny API są oddzielone od logowania do portalu. Token uzyskasz od wsparcia lub administratora konta.

Podmioty

Podmioty to spółki, które monitorujesz. Endpointy są powiązane z kontem przypisanym do Twojego tokenu API.

Zasób /api/subjects

GET /api/subjects

Lista podmiotów

Zwraca monitorowane podmioty uwierzytelnionego konta. Opcjonalne parametry query filtrują i stronicują wynik.

Parametry query

Nazwa	Typ	Opis
`name`	string	Filtr według nazwy podmiotu (częściowe dopasowanie).
`registrationNumber`	string	Filtr według NIP / numeru rejestrowego (częściowe dopasowanie).
`taxIdentifier`	string	Filtr według identyfikatora podatkowego (częściowe dopasowanie).
`birthDate`	date	Filtr według daty urodzenia. Format: YYYY-MM-DD.
`type`	string	Filtr według typu podmiotu. Dozwolone wartości: COMPANY, PERSON.
`country`	string	Kod kraju. Dozwolone wartości: AUSTRIA, BULGARIA, CZECHIA, ESTONIA, GREECE, CROATIA, HUNGARY, LITHUANIA, LATVIA, POLAND, ROMANIA, SLOVAKIA, UKRAINE.
`page`	integer	Indeks strony (od zera).
`resultsPerPage`	integer	Maksymalna liczba pozycji na stronę.

Odpowiedzi

200 — OK — tablica podmiotów.
401 — Unauthorized — brakujący lub nieprawidłowy token API.

cURL

curl -X GET "https://{host}/api/subjects?country=SLOVAKIA" \
-H "Authorization: Bearer {api_token}" \
-H "Accept: application/json"

Odpowiedź

[
  {
    "id": 42,
    "country": "SLOVAKIA",
    "subjectType": "COMPANY",
    "name": "Example s.r.o.",
    "registrationNumber": "12345678",
    "taxIdentifier": "SK12345678",
    "birthDate": null,
    "summary": [
      {
        "severity": "HIGH",
        "date": "2026-01-02",
        "eventName": "Insolvency"
      }
    ]
  }
]

GET /api/subjects/{id}

Szczegóły podmiotu

Zwraca jeden podmiot wraz z notatką i powiązanymi zdarzeniami.

Parametry path

Nazwa	Typ	Opis
`id`	integer	Numeryczny identyfikator podmiotu.

Odpowiedzi

200 — OK — szczegóły podmiotu.
401 — Unauthorized — brakujący lub nieprawidłowy token API.
404 — Not Found — podmiot dla tego konta nie istnieje.

cURL

curl -X GET "https://{host}/api/subjects/42" \
-H "Authorization: Bearer {api_token}" \
-H "Accept: application/json"

Odpowiedź

{
  "id": 42,
  "country": "SLOVAKIA",
  "subjectType": "COMPANY",
  "name": "Example s.r.o.",
  "registrationNumber": "12345678",
  "taxIdentifier": "SK12345678",
  "birthDate": null,
  "note": "VIP partner",
  "events": [
    {
      "id": 1001,
      "severity": "MEDIUM",
      "date": "2026-07-01",
      "title": "Change of registered office",
      "text": "Registered office address was updated.",
      "sourceUrl": "https://example.com/source"
    }
  ]
}

POST /api/subjects

Utworzenie podmiotu

Tworzy nowy monitorowany podmiot. Kombinacja kraju i numeru rejestrowego musi być unikalna w ramach konta.

Treść żądania

Nazwa	Typ	Wymagane	Opis
`country`	string	Tak Wymagane	Kod kraju. Dozwolone wartości: AUSTRIA, BULGARIA, CZECHIA, ESTONIA, GREECE, CROATIA, HUNGARY, LITHUANIA, LATVIA, POLAND, ROMANIA, SLOVAKIA, UKRAINE.
`subjectType`	string	Tak Wymagane	Typ podmiotu. Dozwolone wartości: COMPANY, PERSON.
`name`	string	Tak Wymagane	Nazwa podmiotu (maks. 255 znaków).
`registrationNumber`	string	Tak, jeśli typ to COMPANY Wymagane, jeśli typ to COMPANY	NIP / numer rejestrowy (maks. 64 znaki). Wymagane, jeśli typ to COMPANY.
`taxIdentifier`	string	Nie Opcjonalne	Identyfikator podatkowy (maks. 100 znaków). Opcjonalne.
`birthDate`	date	Nie Opcjonalne	Data urodzenia w formacie YYYY-MM-DD. Opcjonalne.
`note`	string	Nie Opcjonalne	Opcjonalna notatka (maks. 255 znaków).

Odpowiedzi

201 — Created — podmiot został utworzony.
400 — Bad Request — walidacja nie powiodła się lub podmiot już istnieje.
401 — Unauthorized — brakujący lub nieprawidłowy token API.

cURL

curl -X POST "https://{host}/api/subjects" \
-H "Authorization: Bearer {api_token}" \
-H "Content-Type: application/json" \
-d '{
  "country": "SLOVAKIA",
  "subjectType": "COMPANY",
  "name": "Example s.r.o.",
  "registrationNumber": "12345678",
  "taxIdentifier": "SK12345678",
  "birthDate": null,
  "note": "VIP partner"
}'

Odpowiedź

{
  "id": 42,
  "country": "SLOVAKIA",
  "subjectType": "COMPANY",
  "name": "Example s.r.o.",
  "registrationNumber": "12345678",
  "taxIdentifier": "SK12345678",
  "birthDate": null,
  "note": "VIP partner",
  "events": null
}

PUT /api/subjects/{id}

Edycja podmiotu

Modyfikuje edytowalne pola istniejącego podmiotu: typ, identyfikator podatkowy, datę urodzenia i notatkę.

Parametry path

Nazwa	Typ	Opis
`id`	integer	Numeryczny identyfikator podmiotu.

Treść żądania

Nazwa	Typ	Wymagane	Opis
`note`	string	Nie Opcjonalne	Opcjonalna notatka (maks. 255 znaków).

Odpowiedzi

200 — OK — szczegóły podmiotu.
400 — Bad Request — walidacja nie powiodła się lub podmiot już istnieje.
401 — Unauthorized — brakujący lub nieprawidłowy token API.
404 — Not Found — podmiot dla tego konta nie istnieje.

cURL

curl -X PUT "https://{host}/api/subjects/42" \
-H "Authorization: Bearer {api_token}" \
-H "Content-Type: application/json" \
-d '{
  "note": "VIP partner"
}'

DELETE /api/subjects/{id}

Usunięcie podmiotu

Trwale usuwa podmiot i powiązane dane monitorowania konta.

Parametry path

Nazwa	Typ	Opis
`id`	integer	Numeryczny identyfikator podmiotu.

Odpowiedzi

204 — No Content — podmiot został usunięty.
401 — Unauthorized — brakujący lub nieprawidłowy token API.
404 — Not Found — podmiot dla tego konta nie istnieje.

cURL

curl -X DELETE "https://{host}/api/subjects/42" \
-H "Authorization: Bearer {api_token}"

Zdarzenia

Zdarzenia to zmiany monitorowania wykryte przy Twoich podmiotach. Endpointy są powiązane z kontem przypisanym do Twojego tokenu API.

Zasób /api/events

GET /api/events

Lista zdarzeń

Zwraca zdarzenia monitorowania podmiotów uwierzytelnionego konta. Opcjonalne parametry query filtrują i stronicują wynik.

Parametry query

Nazwa	Typ	Opis
`subjectId`	integer	Filtr według numerycznego identyfikatora podmiotu.
`name`	string	Filtr według nazwy podmiotu (częściowe dopasowanie).
`registrationNumber`	string	Filtr według NIP / numeru rejestrowego (częściowe dopasowanie).
`country`	string	Kod kraju. Dozwolone wartości: AUSTRIA, BULGARIA, CZECHIA, ESTONIA, GREECE, CROATIA, HUNGARY, LITHUANIA, LATVIA, POLAND, ROMANIA, SLOVAKIA, UKRAINE.
`page`	integer	Indeks strony (od zera).
`resultsPerPage`	integer	Maksymalna liczba pozycji na stronę.

Odpowiedzi

200 — OK — tablica zdarzeń.
401 — Unauthorized — brakujący lub nieprawidłowy token API.

cURL

curl -X GET "https://{host}/api/events?country=SLOVAKIA" \
-H "Authorization: Bearer {api_token}" \
-H "Accept: application/json"

Odpowiedź

[
  {
    "date": "2026-07-01T12:30:00",
    "severity": "MEDIUM",
    "title": "Business Register",
    "text": "Registered office address was updated.",
    "sourceUrl": "https://example.com/source",
    "subject": {
      "name": "Example s.r.o.",
      "registrationNumber": "12345678",
      "country": "SLOVAKIA"
    }
  }
]

Odpowiedzi błędów

Błędy walidacji używają mapy pól. Niepowodzenie uwierzytelniania zwraca prosty obiekt error.

Błąd walidacji (400)

{
  "errors": {
    "registrationNumber": [
      "ID / registration number is required."
    ]
  }
}

Unauthorized (401)

{
  "error": "Unauthorized"
}

Kody krajów

Dla pola country użyj tych wartości enum:

AUSTRIA
BULGARIA
CZECHIA
ESTONIA
GREECE
CROATIA
HUNGARY
LITHUANIA
LATVIA
POLAND
ROMANIA
SLOVAKIA
UKRAINE

Typy podmiotów

Dla pola subjectType użyj tych wartości enum:

COMPANY
PERSON