Bei der Implementierung der Unternehmensüberwachungsfunktion von Creditsafe Connect über den Endpunkt /monitoring wird empfohlen, zunächst die folgende Aufrufsequenz zu verwenden:
URI | HTTP METHOD |
/monitoring/portfolios | |
/monitoring/eventRules | |
/monitoring/portfolios/{portfolioId}/eventRules/{countryCode} | |
/monitoring/portfolios/{portfolioId}/companies | |
/monitoring/portfolios/{portfolioId}/notificationEvents |
1. Portfolio erstellen
Zunächst muss ein Portfolio über Creditsafe Connect erstellt werden, indem Sie folgende Endpunkte aufrufen:
URI | HTTP METHOD |
/monitoring/portfolios |
Zum Kopieren:
{
"name": "My New Portfolio",
"isDefault": "true"
}
2. Benachrichtigungsregeln abrufen
Eine Liste sämtlicher verfügbarer Benachrichtigungsregeln, die auf das besagte Portfolio angewendet werden können, kann von Creditsafe Connect durch Aufruf des folgenden Endpunkts abgerufen werden:
URI | HTTP METHOD |
/monitoring/eventRules |
3. Aktivieren Sie Benachrichtigungsregeln
Die "notificationEvents" (Benachrichtigungen) von Creditsafe Connect werden nur für die aktiven "eventRules" (Benachrichtigungsregeln) des Portfolios generiert. Wenn also keine "eventRules" aktiv sind, werden keine "notificationEvents" für das Portfolio erstellt. "eventRules" können nur durch den Aufruf des folgenden Endpunkts aktiviert werden:
URI | HTTP METHOD |
/monitoring/portfolios/{portfolioId}/eventRules/{countryCode} |
Zum kopieren:
[
{
"ruleCode": 1801,
"ruleCountryCode": "GB",
"isActive": 1,
"param0": "15"
},
{
"ruleCode": 1802,
"ruleCountryCode": "GB",
"isActive": 1,
"param0": "10"
},
{
"ruleCode": 3054,
"ruleCountryCode": "GB",
"isActive": 1
}
]
4. Unternehmen hinzufügen
Nach der Aktivierung von "eventRules" kann eine "company" (Unternehmen) über den folgenden Creditsafe Connect-Endpunkt zu diesem Portfolio hinzugefügt werden:
URI | HTTP METHOD |
/monitoring/portfolios/{portfolioId}/companies |
Zum kopieren:
{
"id": "GB-0-123456789",
"personalReference": "",
"freeText": "",
"personalLimit": ""
}
5. Benachrichtigungen abrufen
Sobald "eventRules" aktiviert wurden und eine "company" (Unternehmen) zu diesem Portfolio hinzugefügt wurde, sollte der folgende Creditsafe Connect-Endpunkt regelmäßig aufgerufen werden, um zu überwachen, ob "notificationEvents" für die "company" / die "eventRules" erzeugt wurden:
URI | HTTP METHOD |
/monitoring/portfolios/{portfolioId}/notificationEvents |
Dieser Artikel behandelt lediglich die Grundlagen von Creditsafe Connect. Daher empfehlen wir Ihnen, die Creditsafe Connect-Dokumentationsseite unter folgendem Weblink zu besuchen:
Sollten Sie auf Probleme stoßen, können Sie uns gerne ein Ticket einstellen.