Einführung

Mit der CrediCONNECT Rest API wird die bisherige CrediCONNECT SOAP-Schnittstelle ersetzt. Die bisherige Generation der CrediCONNECT-Schnittstelle (WebService) wird nicht weiterentwickelt, bleibt für bestehende Systemkunden in Betrieb. Die Ausserbetriebnahme des WebServices ist auf Ende 2027 geplant.

Scope / Nicht-Ziele

Diese fachliche/technische Spezifikation beschreibt die unterschiedlichen Geschäftsfälle, die mit der API gemacht werden können und enthält auch Beispile von Anfragen und Antworten, um Entwickler:innen in der Umsetzung zu unterstützen.

In dieser Spezifikation werden hingegen keine Aussagen zum Thema Datenschutz gemacht. Die Einhaltung der datenschutzrechtlichen Vorgaben obliegt dem Anwender der Schnittstelle. Die Nutzung der Services von Creditreform richtet sich nach den aktuellen vertraglichen Vereinbarungen resp. allgemeinen Geschäftsbedingungen.

Im Übrigen werden auch keine Empfehlungen für die Nutzung der unterschiedlichen Services oder Aussagen zu kommerziellen Fragen wie Preise etc. gemacht. Die Erklärung der Produkte und Dienstleistungen sowie die Festsetzung der Preise wird durch die zuständigen Kundenberater:innen der Kreisbüros gemacht.

Geschäftsfälle

Hier geht es zur Beschreibung der Geschäftsfälle.
In der Übersicht über die Ressourcen sind die Funktionen der Schnittstelle mit den zugehörigen Ressourcen ebenfalls aufgeführt.

Authentifizierung und Login

Die Authentifizierung der CrediCONNECT API erfolgt über OAuth 2.0. OAuth 2.0 ist ein standardisiertes Autorisierungsprotokoll, das einen sicheren und kontrollierten Zugriff auf geschützte Ressourcen ermöglicht.

Voraussetzung für den Zugriff auf die API ist, dass der Client bzw. die Anwendung vorgängig im Identity Provider (IdP) von Creditreform registriert und freigeschaltet wurde. Im Rahmen dieser Registrierung werden die notwendigen Zugangsdaten sowie die definierten Berechtigungen (Scopes) vergeben.

Für den Zugriff auf die API muss der Client ein Access Token beim Autorisierungsserver anfordern. Dieses Token wird bei jedem API-Aufruf im HTTP-Header mitgesendet:

Authorization: Bearer <access_token>

Das Access Token ist zeitlich begrenzt gültig und definiert die Berechtigungen (Scopes) des aufrufenden Clients. Ohne gültiges Token wird der Zugriff auf die API verweigert.

Die Kommunikation erfolgt ausschließlich über HTTPS, um die Vertraulichkeit und Integrität der übertragenen Daten sicherzustellen.

Um Zugriff zu erhalten, kann mit dem zuständigen Kundenberater Kontakt aufgenommen werden.

Versionierung

Version der Rest API	Verlauf	Version der Spezifikation	Änderung
3.0.4	Erstellen der API und der Spezifikation	3.1	02-2026