API dokumentace

Přehled

Toto REST API umožňuje vytvářet, číst, upravovat a mazat sledované subjekty vašeho účtu a zobrazovat související monitorovací události. Všechny endpointy vrací JSON a vyžadují autentizaci.

Základní URL: /api
Formát: application/json

Autentizace

Každý požadavek musí obsahovat platný API token vydaný pro váš účet. Odešlete ho v hlavičce Authorization ve schématu Bearer.

Hlavička

Authorization: Bearer {api_token}

API tokeny jsou oddělené od přihlášení do portálu. Token získáte od podpory nebo správce účtu.

Subjekty

Subjekty jsou společnosti, které sledujete. Endpointy jsou vázané na účet propojený s vaším API tokenem.

Zdroj /api/subjects

GET /api/subjects

Seznam subjektů

Vrátí sledované subjekty autentizovaného účtu. Volitelné query parametry filtrují a stránkují výsledek.

Query parametry

Název	Typ	Popis
`name`	string	Filtr podle názvu subjektu (částečná shoda).
`registrationNumber`	string	Filtr podle IČO / registračního čísla (částečná shoda).
`taxIdentifier`	string	Filtr podle DIČ (částečná shoda).
`birthDate`	date	Filtr podle data narození. Formát: YYYY-MM-DD.
`type`	string	Filtr podle typu subjektu. Povolené hodnoty: COMPANY, PERSON.
`country`	string	Kód země. Povolené hodnoty: AUSTRIA, BULGARIA, CZECHIA, ESTONIA, GREECE, CROATIA, HUNGARY, LITHUANIA, LATVIA, POLAND, ROMANIA, SLOVAKIA, UKRAINE.
`page`	integer	Index stránky (od nuly).
`resultsPerPage`	integer	Maximální počet položek na stránku.

Odpovědi

200 — OK — pole subjektů.
401 — Unauthorized — chybějící nebo neplatný API token.

cURL

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

Odpověď

[
  {
    "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}

Detail subjektu

Vrátí jeden subjekt včetně poznámky a souvisejících událostí.

Path parametry

Název	Typ	Popis
`id`	integer	Číselný identifikátor subjektu.

Odpovědi

200 — OK — detail subjektu.
401 — Unauthorized — chybějící nebo neplatný API token.
404 — Not Found — subjekt pro tento účet neexistuje.

cURL

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

Odpověď

{
  "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

Vytvoření subjektu

Vytvoří nový sledovaný subjekt. Kombinace země a registračního čísla musí být v rámci účtu unikátní.

Tělo požadavku

Název	Typ	Povinné	Popis
`country`	string	Ano Povinné	Kód země. Povolené hodnoty: AUSTRIA, BULGARIA, CZECHIA, ESTONIA, GREECE, CROATIA, HUNGARY, LITHUANIA, LATVIA, POLAND, ROMANIA, SLOVAKIA, UKRAINE.
`subjectType`	string	Ano Povinné	Typ subjektu. Povolené hodnoty: COMPANY, PERSON.
`name`	string	Ano Povinné	Název subjektu (max. 255 znaků).
`registrationNumber`	string	Ano, pokud je typ COMPANY Povinné, pokud je typ COMPANY	IČO / registrační číslo (max. 64 znaků). Povinné, pokud je typ COMPANY.
`taxIdentifier`	string	Ne Nepovinné	DIČ (max. 100 znaků). Volitelné.
`birthDate`	date	Ne Nepovinné	Datum narození ve formátu YYYY-MM-DD. Volitelné.
`note`	string	Ne Nepovinné	Volitelná poznámka (max. 255 znaků).

Odpovědi

201 — Created — subjekt byl vytvořen.
400 — Bad Request — selhala validace nebo subjekt již existuje.
401 — Unauthorized — chybějící nebo neplatný API token.

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"
}'

Odpověď

{
  "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}

Úprava subjektu

Upraví editovatelná pole existujícího subjektu: typ, DIČ, datum narození a poznámku.

Path parametry

Název	Typ	Popis
`id`	integer	Číselný identifikátor subjektu.

Tělo požadavku

Název	Typ	Povinné	Popis
`note`	string	Ne Nepovinné	Volitelná poznámka (max. 255 znaků).

Odpovědi

200 — OK — detail subjektu.
400 — Bad Request — selhala validace nebo subjekt již existuje.
401 — Unauthorized — chybějící nebo neplatný API token.
404 — Not Found — subjekt pro tento účet neexistuje.

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}

Smazání subjektu

Trvale smaže subjekt a související monitorovací data účtu.

Path parametry

Název	Typ	Popis
`id`	integer	Číselný identifikátor subjektu.

Odpovědi

204 — No Content — subjekt byl smazán.
401 — Unauthorized — chybějící nebo neplatný API token.
404 — Not Found — subjekt pro tento účet neexistuje.

cURL

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

Události

Události jsou monitorovací změny zjištěné u vašich subjektů. Endpointy jsou vázané na účet propojený s vaším API tokenem.

Zdroj /api/events

GET /api/events

Seznam událostí

Vrátí monitorovací události subjektů autentizovaného účtu. Volitelné query parametry filtrují a stránkují výsledek.

Query parametry

Název	Typ	Popis
`subjectId`	integer	Filtr podle číselného identifikátoru subjektu.
`name`	string	Filtr podle názvu subjektu (částečná shoda).
`registrationNumber`	string	Filtr podle IČO / registračního čísla (částečná shoda).
`country`	string	Kód země. Povolené hodnoty: AUSTRIA, BULGARIA, CZECHIA, ESTONIA, GREECE, CROATIA, HUNGARY, LITHUANIA, LATVIA, POLAND, ROMANIA, SLOVAKIA, UKRAINE.
`page`	integer	Index stránky (od nuly).
`resultsPerPage`	integer	Maximální počet položek na stránku.

Odpovědi

200 — OK — pole událostí.
401 — Unauthorized — chybějící nebo neplatný API token.

cURL

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

Odpověď

[
  {
    "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"
    }
  }
]

Chybové odpovědi

Validační chyby používají mapu polí. Selhání autentizace vrací jednoduchý error objekt.

Validační chyba (400)

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

Unauthorized (401)

{
  "error": "Unauthorized"
}

Kódy zemí

Pro pole country použijte tyto enum hodnoty:

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

Typy subjektů

Pro pole subjectType použijte tyto enum hodnoty:

COMPANY
PERSON