API

API dokumentácia

Napojte corween na svoje systémy. Autentifikujte sa API tokenom a spravujte sledované subjekty a udalosti cez HTTPS.

Prehľad

Toto REST API umožňuje vytvárať, čítať, upravovať a mazať sledované subjekty vášho účtu a zobrazovať súvisiace monitorovacie udalosti. Všetky endpointy vracajú JSON a vyžadujú autentifikáciu.

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

Autentifikácia

Každá požiadavka musí obsahovať platný API token vydaný pre váš účet. Pošlite ho v hlavičke Authorization v schéme Bearer.

Hlavička
Authorization: Bearer {api_token}

API tokeny sú oddelené od prihlásenia do portálu. Token získate od podpory alebo správcu účtu.

Subjekty

Subjekty sú spoločnosti, ktoré sledujete. Endpointy sú viazané na účet prepojený s vaším API tokenom.

Zdroj /api/subjects

GET /api/subjects

Zoznam subjektov

Vráti sledované subjekty autentifikovaného účtu. Voliteľné query parametre filtrujú a stránkujú výsledok.

Query parametre

Názov Typ Popis
name string Filter podľa názvu subjektu (čiastočná zhoda).
registrationNumber string Filter podľa IČ / registračného čísla (čiastočná zhoda).
taxIdentifier string Filter podľa IČ DPH (čiastočná zhoda).
birthDate date Filter podľa dátumu narodenia. Formát: YYYY-MM-DD.
type string Filter podľa typu subjektu. Povolené hodnoty: COMPANY, PERSON.
country string Kód krajiny. 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álny počet položiek na stránku.

Odpovede

  • 200 — OK — pole subjektov.
  • 401 — Unauthorized — chýbajúci alebo neplatný API token.
cURL
curl -X GET "https://{host}/api/subjects?country=SLOVAKIA" \
-H "Authorization: Bearer {api_token}" \
-H "Accept: application/json"
Odpoveď
[
  {
    "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áti jeden subjekt vrátane poznámky a súvisiacich udalostí.

Path parametre

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

Odpovede

  • 200 — OK — detail subjektu.
  • 401 — Unauthorized — chýbajúci alebo neplatný API token.
  • 404 — Not Found — subjekt pre tento účet neexistuje.
cURL
curl -X GET "https://{host}/api/subjects/42" \
-H "Authorization: Bearer {api_token}" \
-H "Accept: application/json"
Odpoveď
{
  "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

Vytvorenie subjektu

Vytvorí nový sledovaný subjekt. Kombinácia krajiny a registračného čísla musí byť v rámci účtu unikátna.

Telo požiadavky

Názov Typ Povinné Popis
country string Áno Povinné Kód krajiny. Povolené hodnoty: AUSTRIA, BULGARIA, CZECHIA, ESTONIA, GREECE, CROATIA, HUNGARY, LITHUANIA, LATVIA, POLAND, ROMANIA, SLOVAKIA, UKRAINE.
subjectType string Áno Povinné Typ subjektu. Povolené hodnoty: COMPANY, PERSON.
name string Áno Povinné Názov subjektu (max. 255 znakov).
registrationNumber string Áno, ak je typ COMPANY Povinné, ak je typ COMPANY IČ / registračné číslo (max. 64 znakov). Povinné, ak je typ COMPANY.
taxIdentifier string Nie Nepovinné IČ DPH (max. 100 znakov). Voliteľné.
birthDate date Nie Nepovinné Dátum narodenia vo formáte YYYY-MM-DD. Voliteľné.
note string Nie Nepovinné Voliteľná poznámka (max. 255 znakov).

Odpovede

  • 201 — Created — subjekt bol vytvorený.
  • 400 — Bad Request — zlyhala validácia alebo subjekt už existuje.
  • 401 — Unauthorized — chýbajúci alebo 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"
}'
Odpoveď
{
  "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í editovateľné polia existujúceho subjektu: typ, IČ DPH, dátum narodenia a poznámku.

Path parametre

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

Telo požiadavky

Názov Typ Povinné Popis
note string Nie Nepovinné Voliteľná poznámka (max. 255 znakov).

Odpovede

  • 200 — OK — detail subjektu.
  • 400 — Bad Request — zlyhala validácia alebo subjekt už existuje.
  • 401 — Unauthorized — chýbajúci alebo neplatný API token.
  • 404 — Not Found — subjekt pre 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}

Zmazanie subjektu

Trvalo zmaže subjekt a súvisiace monitorovacie dáta účtu.

Path parametre

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

Odpovede

  • 204 — No Content — subjekt bol zmazaný.
  • 401 — Unauthorized — chýbajúci alebo neplatný API token.
  • 404 — Not Found — subjekt pre tento účet neexistuje.
cURL
curl -X DELETE "https://{host}/api/subjects/42" \
-H "Authorization: Bearer {api_token}"

Udalosti

Udalosti sú monitorovacie zmeny zistené pri vašich subjektoch. Endpointy sú viazané na účet prepojený s vaším API tokenom.

Zdroj /api/events

GET /api/events

Zoznam udalostí

Vráti monitorovacie udalosti subjektov autentifikovaného účtu. Voliteľné query parametre filtrujú a stránkujú výsledok.

Query parametre

Názov Typ Popis
subjectId integer Filter podľa číselného identifikátora subjektu.
name string Filter podľa názvu subjektu (čiastočná zhoda).
registrationNumber string Filter podľa IČ / registračného čísla (čiastočná zhoda).
country string Kód krajiny. 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álny počet položiek na stránku.

Odpovede

  • 200 — OK — pole udalostí.
  • 401 — Unauthorized — chýbajúci alebo neplatný API token.
cURL
curl -X GET "https://{host}/api/events?country=SLOVAKIA" \
-H "Authorization: Bearer {api_token}" \
-H "Accept: application/json"
Odpoveď
[
  {
    "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é odpovede

Validačné chyby používajú mapu polí. Zlyhanie autentifikácie vracia jednoduchý error objekt.

Validačná chyba (400)
{
  "errors": {
    "registrationNumber": [
      "ID / registration number is required."
    ]
  }
}
Unauthorized (401)
{
  "error": "Unauthorized"
}

Kódy krajín

Pre pole country použite tieto enum hodnoty:

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

Typy subjektov

Pre pole subjectType použite tieto enum hodnoty:

  • COMPANY
  • PERSON