Smart Data Hub Handbuch

Informationen zum Dokument und Nutzungsanweisungen

Diese Dokumentation beschreibt die Grundlagen der Fachbegriffe aller Smart Data APIs, die von der STP Business Information GmbH entwickelt wurden. Sie enthält Informationen zur technischen Struktur für die Integration in andere Systeme.

Der Inhalt dieses Dokuments ist vertraulich zu behandeln. Ohne vorherige schriftliche Zustimmung der STP Business Information GmbH darf kein Teil davon reproduziert, verarbeitet, vervielfältigt oder in irgendeiner Form, auch nicht elektronisch, verbreitet werden.

© Copyright STP Business Information GmbH. Alle Rechte vorbehalten.

Verfügbare APIs

Im Smart Data Hub sind derzeit folgende APIs verfügbar:

Authentifizierung

Die Authentifizierung im Data Hub erfolgt entweder über API-Key oder über Username und Passwort.

Nach erfolgreicher Authentifizierung erhalten Sie als Rückgabe ein JSON mit einem Token (JWT) und der Gültigkeitsdauer des Tokens. Der Token ist bei jedem Request im Header als Token mit zu übergeben.

Requests

Minimal-Header

Der minimal erfolderliche Header eines Request ist wie folgt deifiniert:

Content-Type: application/json;charset=UTF-8
Content-Length: 999

Alle anderen Endpunkte, außer get_token bei der Authentifizierung, benötigen einen validen Token:
Token: aaaaa.bbbbbb.cccccc

Pflichtparameter

In allen Endpunkten des Data Hub müssen folgende Parameter mit im Request übergeben werden:

Parameter Beschreibung
application_id Erhalten Sie beim Onboarding
application_customer_id Erhalten Sie beim Onboarding
legitimate_interest_id Entnehmen Sie bitte aus Anlage A

Request-Body

Das folgende JSON-Format ist für jeden Request standard:

{
    "application_id": <application_id>,
    "application_customer_id": <application_customer_id>,
    "legitimate_interest_id": <legitimate_interest_id>,
    ... + more information of antoher function
}

InsoData-API Dokumentation

Die Dokumentation zur InsoData-API finden Sie hier:

BizData-API Dokumentation

Die Dokumentation zur BizData-API finden Sie hier:

Inso-Biz-Monitor Dokumentation

Die Dokumentation zur Monitor-API finden Sie hier:

Anlage A - Legitimate Interest ID

ID Beschreibung
1 Anbahnung eines Kaufvertrags (DSGVO § 6f)
2 Überwachung eines bestehenden Dauerschuldverhältnis (DSGVO § 6f)
3 Einwilligung des Betroffenen (DSGVO § 6a)
4 Erfüllung eines Vertrags mit dem Betroffenen (DSGVO § 6b)
5 rechtliche Verpflichtung des Verantwortlichen (DSGVO § 6c)
6 Aufgabe im Rahmen öffentlichen Interesses (DSGVO § 6e)

Verknüpfung mit