API-Dokumentation

Überblick

Diese REST-API ermöglicht das Erstellen, Lesen, Aktualisieren und Löschen überwachter Subjekte Ihres Kontos sowie das Abrufen zugehöriger Monitoring-Ereignisse. Alle Endpunkte liefern JSON und erfordern Authentifizierung.

Basis-URL: /api
Format: application/json

Authentifizierung

Jede Anfrage muss ein gültiges API-Token für Ihr Konto enthalten. Senden Sie es im Authorization-Header im Bearer-Schema.

Header

Authorization: Bearer {api_token}

API-Tokens sind von Portal-Login-Sitzungen getrennt. Wenden Sie sich an den Support oder Ihren Kontoadministrator, um ein Token zu erhalten.

Subjekte

Subjekte sind Unternehmen, die Sie überwachen. Endpunkte sind auf das mit Ihrem API-Token verknüpfte Konto beschränkt.

Ressource /api/subjects

GET /api/subjects

Subjekte auflisten

Gibt überwachte Subjekte des authentifizierten Kontos zurück. Optionale Query-Parameter filtern und paginieren das Ergebnis.

Query-Parameter

Name	Typ	Beschreibung
`name`	string	Filter nach Subjektname (Teilübereinstimmung).
`registrationNumber`	string	Filter nach Identifikations-/Registrierungsnummer (Teilübereinstimmung).
`taxIdentifier`	string	Filter nach Steuer-ID (Teilübereinstimmung).
`birthDate`	date	Filter nach Geburtsdatum. Format: YYYY-MM-DD.
`type`	string	Filter nach Subjekttyp. Erlaubte Werte: COMPANY, PERSON.
`country`	string	Ländercode. Erlaubte Werte: AUSTRIA, BULGARIA, CZECHIA, ESTONIA, GREECE, CROATIA, HUNGARY, LITHUANIA, LATVIA, POLAND, ROMANIA, SLOVAKIA, UKRAINE.
`page`	integer	Nullbasierter Seitenindex.
`resultsPerPage`	integer	Maximale Anzahl von Einträgen pro Seite.

Antworten

200 — OK — Array von Subjekten.
401 — Unauthorized — fehlendes oder ungültiges API-Token.

cURL

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

Antwort

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

Subjekt abrufen

Gibt ein einzelnes Subjekt einschließlich Notiz und zugehöriger Ereignisse zurück.

Pfad-Parameter

Name	Typ	Beschreibung
`id`	integer	Numerischer Subjekt-Identifikator.

Antworten

200 — OK — Subjektdetail.
401 — Unauthorized — fehlendes oder ungültiges API-Token.
404 — Not Found — Subjekt existiert für dieses Konto nicht.

cURL

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

Antwort

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

Subjekt erstellen

Erstellt ein neues überwachtes Subjekt. Land und Registrierungsnummer müssen innerhalb des Kontos eindeutig sein.

Request-Body

Name	Typ	Pflicht	Beschreibung
`country`	string	Ja Pflicht	Ländercode. Erlaubte Werte: AUSTRIA, BULGARIA, CZECHIA, ESTONIA, GREECE, CROATIA, HUNGARY, LITHUANIA, LATVIA, POLAND, ROMANIA, SLOVAKIA, UKRAINE.
`subjectType`	string	Ja Pflicht	Subjekttyp. Erlaubte Werte: COMPANY, PERSON.
`name`	string	Ja Pflicht	Anzeigename des Subjekts (max. 255 Zeichen).
`registrationNumber`	string	Ja, wenn Typ COMPANY Pflicht, wenn Typ COMPANY	Identifikations-/Registrierungsnummer (max. 64 Zeichen). Pflicht, wenn Typ COMPANY ist.
`taxIdentifier`	string	Nein Optional	Steuer-ID (max. 100 Zeichen). Optional.
`birthDate`	date	Nein Optional	Geburtsdatum im Format YYYY-MM-DD. Optional.
`note`	string	Nein Optional	Optionale Freitextnotiz (max. 255 Zeichen).

Antworten

201 — Created — Subjekt wurde erstellt.
400 — Bad Request — Validierung fehlgeschlagen oder Subjekt existiert bereits.
401 — Unauthorized — fehlendes oder ungültiges 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"
}'

Antwort

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

Subjekt aktualisieren

Aktualisiert bearbeitbare Felder eines bestehenden Subjekts: Typ, Steuer-ID, Geburtsdatum und Notiz.

Pfad-Parameter

Name	Typ	Beschreibung
`id`	integer	Numerischer Subjekt-Identifikator.

Request-Body

Name	Typ	Pflicht	Beschreibung
`note`	string	Nein Optional	Optionale Freitextnotiz (max. 255 Zeichen).

Antworten

200 — OK — Subjektdetail.
400 — Bad Request — Validierung fehlgeschlagen oder Subjekt existiert bereits.
401 — Unauthorized — fehlendes oder ungültiges API-Token.
404 — Not Found — Subjekt existiert für dieses Konto nicht.

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}

Subjekt löschen

Löscht ein Subjekt und die zugehörigen Monitoring-Daten des Kontos dauerhaft.

Pfad-Parameter

Name	Typ	Beschreibung
`id`	integer	Numerischer Subjekt-Identifikator.

Antworten

204 — No Content — Subjekt wurde gelöscht.
401 — Unauthorized — fehlendes oder ungültiges API-Token.
404 — Not Found — Subjekt existiert für dieses Konto nicht.

cURL

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

Ereignisse

Ereignisse sind Monitoring-Änderungen, die für Ihre Subjekte erkannt wurden. Endpunkte sind auf das mit Ihrem API-Token verknüpfte Konto beschränkt.

Ressource /api/events

GET /api/events

Ereignisse auflisten

Gibt Monitoring-Ereignisse der Subjekte des authentifizierten Kontos zurück. Optionale Query-Parameter filtern und paginieren das Ergebnis.

Query-Parameter

Name	Typ	Beschreibung
`subjectId`	integer	Filter nach numerischem Subjekt-Identifikator.
`name`	string	Filter nach Subjektname (Teilübereinstimmung).
`registrationNumber`	string	Filter nach Identifikations-/Registrierungsnummer (Teilübereinstimmung).
`country`	string	Ländercode. Erlaubte Werte: AUSTRIA, BULGARIA, CZECHIA, ESTONIA, GREECE, CROATIA, HUNGARY, LITHUANIA, LATVIA, POLAND, ROMANIA, SLOVAKIA, UKRAINE.
`page`	integer	Nullbasierter Seitenindex.
`resultsPerPage`	integer	Maximale Anzahl von Einträgen pro Seite.

Antworten

200 — OK — Array von Ereignissen.
401 — Unauthorized — fehlendes oder ungültiges API-Token.

cURL

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

Antwort

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

Fehlerantworten

Validierungsfehler verwenden eine Feld-Map. Authentifizierungsfehler geben ein einfaches error-Objekt zurück.

Validierungsfehler (400)

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

Unauthorized (401)

{
  "error": "Unauthorized"
}

Ländercodes

Verwenden Sie diese Enum-Werte für das Feld country:

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

Subjekttypen

Verwenden Sie diese Enum-Werte für das Feld subjectType:

COMPANY
PERSON