Verwendung der API
Importieren Sie die Postman-Sammlung, um Ihre Instanz abzurufen und eine Entscheidung anzufordern.
WICHTIG: Bitte stellen Sie sicher, dass Ihre Postman-Umgebung mit Globals und Locals eingerichtet ist.
Importieren Sie die Sammlung, indem Sie in der Kopfzeile „Mein Arbeitsbereich“ die Option „Importieren“ auswählen.
Wählen Sie die Datei aus dem Speicherort auf Ihrem Gerät aus und importieren Sie die Sammlung.
WICHTIG: Alle Elemente werden während dieses Vorgangs importiert.
Authentifizierung
Die Authentifizierung umfasst das Senden eines verifizierten Benutzernamens und Passworts mit Ihrer Anfrage. Wählen Sie in der Registerkarte „Autorisierung” der Anfrage „Bearer Token” aus der Dropdown-Liste „Typ” aus.
Geben Sie Ihren Connect-API-Benutzernamen und Ihr Passwort in die Felder „Benutzername” und „Passwort” ein. Speichern Sie diese zur zusätzlichen Sicherheit in Variablen.
Beispiel unten:
Klicken Sie auf die Registerkarte „Authentifizieren“ und führen Sie die folgenden Überprüfungen durch, bevor Sie auf „Senden“ klicken, um die Anfrage für eine erfolgreiche Authentifizierung zu senden:
Autorisierung:
Typ – Bearer-Token
Token – {{token}}
Body:
{
„username“: „“, [Connect API-Benutzername]
„password“: „“ [Connect API-Passwort]
}
Tests:
var jsonData = JSON.parse(responseBody);
pm.globals.set(„token“, jsonData.token);
Sobald die oben genannten Überprüfungen abgeschlossen sind, klicken Sie auf die Schaltfläche „Senden“, um Ihr Token zu generieren.
Wenn das Token abgelaufen ist, muss sich der Benutzer erneut authentifizieren. Das Token ist für einen bestimmten Zeitraum gültig, bevor es am selben Endpunkt aktualisiert werden muss.
Abrufen Ihrer Entscheidungskonfiguration
GET-Methoden dienen in der Regel zum Abrufen von Daten aus unserer Connect-API. Wir können alle Instanzen über die Anfrage „Get Instances“ abrufen.
Wählen Sie die GUID-ID aus „Get Instances“ aus.
Navigieren Sie nun zur Anfrage „Get Instance Configuration“ und übergeben Sie die GUID-Parameter als Pfadvariablen.
Klicken Sie auf die Schaltfläche „Senden“, um Ihre Instanzkonfiguration abzurufen.
Entscheidungsfindung
1. Klicken Sie auf die Registerkarte „Connect – Decision Making“ und führen Sie die folgenden Überprüfungen durch, bevor Sie auf „Senden“ klicken, um die Entscheidung zu treffen.
Parameter – Fügen Sie einen neuen Schlüssel namens companyId hinzu: Übergeben Sie die Unternehmens-ID, für die Sie eine Entscheidung anfordern möchten.
Fügen Sie einen neuen Schlüssel namens guid hinzu – übergeben Sie die GUID, die wir aus der Antwort auf die GET-Methode für Ihre Instanz erhalten haben.
Body – Fügen Sie den Body wie unten angegeben hinzu (ignorieren Sie ihn, wenn er bereits vorhanden ist)
{
„creditAmount“: „Dies ist die Benutzereingabe, die wir bei der Entscheidung übermitteln müssen“
}
2. Sobald die oben genannten Überprüfungen abgeschlossen sind, klicken Sie auf „Senden“, um die Entscheidung anzufordern. Sie erhalten dann eine JSON-Antwort mit den einzelnen Ergebnissen der Überprüfungen und dem Endergebnis (Entscheidung).
WICHTIG: Bitte beachten Sie, dass das Endergebnis der höchste Risikowert aller durchgeführten Überprüfungen ist. Der Entscheidungstext ist leer, wenn das Endergebnis „Akzeptieren“ lautet.
Instanzkonfiguration
Instanz abrufen
Dieser Endpunkt wird verwendet, um die Konfigurationsdetails der Instanz abzurufen.
Der Benutzer muss das Token generieren, indem er die unter „Authentifizierung“ genannten Schritte ausführt.
URL: https://connect.creditsafe.com/v1/authenticate
Führen Sie eine GET-Instanzkonfiguration durch, indem Sie die GUID als Pfadvariable übergeben.
Header: Token übergeben
Abfrageparameter: Nicht zutreffend
URL: https://connect.creditsafe.com/v1/decisionEngine/instance/:guid
Klicken Sie auf „Senden“, um die Instanzkonfiguration abzurufen.
Benutzer sollten die Konfigurationsdetails erfolgreich mit dem Statuscode 200 erhalten, wie unten gezeigt.
Instanz aktualisieren
Dieser Endpunkt wird verwendet, um die Konfiguration des konfigurierten Entscheidungsbaums zu aktualisieren. Mit diesem Endpunkt können wir Metriken aus einer Konfiguration aktivieren/deaktivieren, die Schwellenwerte aktualisieren, die Status „Fehlgeschlagen“ und „Nicht verfügbar“ ändern, den Schlüssel „Veröffentlicht“ aktualisieren und den Namen des Entscheidungsbaums aktualisieren.
Hinweis 1: Benutzer können keine Aktualisierungen am readOnly-Schlüssel und der customerId vornehmen.
Hinweis 2: Benutzer müssen eine GET-Instanzkonfiguration durchführen, bevor sie Änderungen an der Instanzkonfiguration vornehmen können. Auf diese Weise können Benutzer vor jeder Aktualisierung die aktuellen Konfigurationsdetails einsehen.
Benutzer können die Antwort-JSON der GET-Instanzkonfiguration kopieren.
2. Geben Sie die durch die GET-Anfrage generierte JSON-Konfiguration der Instanz in den „Body“ ein.
Header: Pass-Token
Abfrageparameter: Nicht zutreffend
URL: https://connect.creditsafe.com/v1/decisionEngine/instance/:guid
3. Benutzer können die Konfigurationsdetails gemäß den Anforderungen aktualisieren.
4. Ändern Sie die Methode von „GET“ zu „PUT“.
5. Nachdem Benutzer den „Body“ aktualisiert haben, können sie auf „Senden“ klicken, um die Konfiguration zu aktualisieren.
6. Erfolgreich aktualisierte Konfigurationen zeigen einen Statuscode 200 sowie den aktualisierten Konfigurations-Body an.
7. Wenn ein Benutzer eine GET-Anfrage mit derselben GUID ausführt, sollte er die aktualisierten Konfigurationsinformationen sehen.
Entscheidungsergebnisse und Entscheidungsbeschreibungen
Werte für Entscheidungsergebnisse und Entscheidungsbeschreibungen abrufen
Dieser Endpunkt wird verwendet, um das Entscheidungsergebnis und die Details zur Entscheidungsbeschreibung der Instanz abzurufen.
Der Benutzer muss das Token generieren, indem er die unter „Authentifizierung“ genannten Schritte ausführt.
URL: https://connect.creditsafe.com/v1/authenticate
Führen Sie eine GET-Entscheidungsergebnisabfrage durch, indem Sie die GUID als Pfadvariable übergeben.
Header: Token übergeben
Abfrageparameter: Nicht zutreffend
URL: https://connect.creditsafe.com/v1/decisionEngine/decisionOutcome/:guid
3. Klicken Sie auf „Senden“, um die Instanzkonfiguration abzurufen.
4. Der Benutzer sollte die Details zum Entscheidungsergebnis und zur Entscheidungsbeschreibung für die GUID erfolgreich abrufen können.
Werte für Entscheidungsergebnisse und Entscheidungsbeschreibungen aktualisieren
Dieser Endpunkt wird verwendet, um die Werte für das Entscheidungsergebnis und die Beschreibungen des Entscheidungsergebnisses für verschiedene Statuscodes anzupassen und den manuellen Überprüfungsprozess für die ausgewählte GUID einzuschränken, d. h. durch Aktualisieren des Werts des Schlüssels „includeInManualReview”. Der für den Schlüssel „includeInManualReview” definierte Wert bestimmt, ob der manuelle Überprüfungsprozess für die GUID anwendbar ist oder eingeschränkt wird, wenn das Entscheidungsergebnis „status: 2” lautet.
Benutzer können die Antwort-JSON des GET-Entscheidungsergebnisses kopieren.
2. Geben Sie die JSON-Konfiguration der durch die GET-Anfrage generierten Instanz in den „Body“ ein.
Header: Pass-Token
Abfrageparameter: Nicht zutreffend
URL: https://connect.creditsafe.com/v1/decisionEngine/decisionOutcome/:guid
3. Benutzer können die Werte der Entscheidungsergebnisse, die Beschreibungen der Entscheidungsergebnisse und den Wert des Schlüssels „includeInManualReview” entsprechend den Anforderungen anpassen.
4. Ändern Sie die Methode von „GET“ zu „PATCH“.
5. Nachdem Benutzer die Details aktualisiert haben, können sie auf „Senden“ klicken, um eine PATCH-Operation durchzuführen. Benutzer müssen eine Erfolgsmeldung mit dem Statuscode 200 sehen können, wie unten gezeigt:
6. Wenn ein Benutzer einen GET für dieselbe GUID durchführt, muss er die aktualisierten Details zum Entscheidungsergebnis sehen.
Aktualisierter GUID-Listen-Endpunkt
Der GUID-Listen-Endpunkt wurde um einen neuen Schlüssel „decisionOutcome” erweitert. Dieser neu eingeführte Schlüssel ist nur für den Typ „CS Decision Module” verfügbar.
Header: Pass-Token
Abfrageparameter: Übergeben Sie den Schlüssel „decisionOutcome” als „true”.
URL: https://connect.creditsafe.com/v1/decisionEngine/GUID?decisionOutcome=true
Aktualisierte Instanzprotokollhistorie anzeigen
Der Benutzer kann alle Änderungen am Entscheidungsbaum in Bezug auf Konfigurationsänderungen oder Aktualisierungen der Entscheidungsergebniswerte und Entscheidungsergebnisbeschreibungen anzeigen. Die Baumkonfigurationsprotokolle erfassen die Historie aller Änderungen, die an den Entscheidungswerten und Entscheidungsbeschreibungen für einen Entscheidungsbaum vorgenommen wurden.
Der Benutzer muss das Token generieren, indem er die unter „Authentifizierung“ genannten Schritte ausführt.
URL: https://connect.creditsafe.com/v1/authenticate
Instanzprotokollverlauf für Konfigurationsaktualisierungen/Aktualisierungen der Entscheidungsergebnisse
2. Führen Sie ein GET-Instanzprotokoll durch, indem Sie die GUID als Abfragevariablen übergeben.
Header: Token übergeben
Abfrageparameter: GUID übergeben
URL: https://connect.creditsafe.com/v1/decisionEngine/instanceLog?guid=
Bezeichnung des Entscheidungsergebnisses aktualisiert
Beschreibung des Entscheidungsergebnisses aktualisiert
Neue Metrik hinzugefügt – Schlüssel „isRequired” von „False” auf „true” aktualisiert
Neue Metrik hinzugefügt – Schwellenwert von „-” auf „neuer Wert” aktualisiert