Schnellstart

Voraussetzungen

  • Laden Sie die SDK Dateien herunter und entpacken Sie sie.
  • Halten Sie Ihre Zugangsdaten für die CRIF Test-Schnittstelle bereit.

Einbinden des SDK in Ihren Code

Sie können das SDK in Ihren Code mit einer einzigen require-Anweisung einbinden. Ersetzen Sie /path/to/ in dem nachfolgenden Code durch den tatsächlichen Pfad auf Ihrem System: 

require '/path/to/Api.php';

Erstellen einer Anfrage

Sie können eine Anfrage erstellen, indem Sie eine neue Instanz der API generieren und die folgenden Werte mitgeben:

$check = new CrifBuergelOrdercheck\Api(
    $user, // CRIF Bürgel API Benutzername
    $password, // CRIF Bürgel API Passwort
    $product, // CRIF Bürgel Produkt, z.B. CreditCheckOne
    'test', // test = Test-Modus, live = Live-Modus
    5, // Timeout für diese Anfrage
    $logFile, // Logfile für Protokoll (z.B. var/log/buergel.log)
    true // Speicherung personenbezogener Daten im Protokoll true/false
);

Oder für einen Check über b.ONE

$check = new CrifBuergelBOne\Api(
    $user, // CRIF Bürgel API Benutzername
    $password, // CRIF Bürgel API Passwort
    $product, // CRIF Bürgel Produkt, z.B. CreditCheckOne
    'test', // test = Test-Modus, live = Live-Modus
    5, // Timeout für diese Anfrage
    $logFile, // Logfile für Protokoll (z.B. var/log/buergel.log)
    true // Speicherung personenbezogener Daten im Protokoll true/false
);

Zum Erstellen einer Anfrage benötigen Sie neben den Zugangsdaten für die CRIF Schnittstelle und den Werten für die benannten Einstellungen noch die Daten zu demjenigen, für den eine Anfrage gestellt werden soll. Diese können Sie wie folgt an die Schnittstelle übergeben:

$check->setAttribute(
    $data
);

Hierbei enthält $data Ihre Anfrage. Diese könnte z.B. für den Ordercheck wie folgt aussehen:

$data = [
    ['searchedAddress.legalForm','PERSON'],
    ['searchedAddress.address.name','Mustermann']),
    ['searchedAddress.address.firstName','Max'],
    ['searchedAddress.address.dateOfBirth','19680414'],
    ['searchedAddress.address.location.street','Musterstraße'],
    ['searchedAddress.address.location.house','3'],
    ['searchedAddress.address.location.city','Musterhausen'],
    ['searchedAddress.address.location.zip','1337'],
    ['searchedAddress.address.location.country','DEU'],
];

Für eine Firma sähe die Anfrage wie folgt aus:

$data = [
    ['searchedAddress.legalForm','COMPANY'],
    ['searchedAddress.address.name','Musterfirma GmbH']),
    ['searchedAddress.address.location.street','Musterstraße'],
    ['searchedAddress.address.location.house','3'],
    ['searchedAddress.address.location.city','Musterhausen'],
    ['searchedAddress.address.location.zip','1337'],
    ['searchedAddress.address.location.country','DEU'],
];

Für b.ONE sieht die Anfrage z.B. so aus:

$data = [
    ['reportRequestData.entity.name','Mustermann']),
    ['reportRequestData.entity.firstName','Max'],
    ['reportRequestData.entity.dateOfBirth','19680414'],
    ['reportRequestData.entity.location.street','Musterstraße 3'],
    ['reportRequestData.entity.location.city','Musterhausen'],
    ['reportRequestData.entity.location.zip','1337'],
    ['reportRequestData.entity.location.country.code','DEU'],
];

Bzw. für eine Firma wie folgt:

$data = [
    ['reportRequestData.entity.name','Musterfirma GmbH']),
    ['reportRequestData.entity.location.street','Musterstraße 3'],
    ['reportRequestData.entity.location.city','Musterhausen'],
    ['reportRequestData.entity.location.zip','1337'],
    ['reportRequestData.entity.location.country.code','DEU'],
];

Optional können Sie eine eigene Referenz für diese Angabe mitgeben, die auf der Abrechnung erscheint. Für den Ordercheck mit:

$data[] = ['clientData.reference','Referenz'];

Für b.ONE mit:

$data[] = ['reportRequestData.userReference.inquiryReference','Referenz'];

Sie können die Anfrage im Anschluss wie folgt absenden:

$response = $check->check();

$response enthält nach dem Absenden ein Array mit den Rückgabewerten der Schnittstelle. Im Erfolgsfall einer Anfrage gegen die API ist $response[’success‘] true. In dem Array werden, je nach Schnittstelle, unterschiedliche Werte zurückgegeben. Deren Interpretation erfolgt analog der CRIF Ordercheck/b.ONE Dokumentationen.

Grundsätzlich können über das $data-Array alle in der CRIF Schnittstellendefinition dargelegten Werte per Dot-Notation übergeben werden. Das $response-Array enthält ebenso alle Rückgabewerte, auf die nach dem Check direkt zugegriffen werden kann.

Related Articles