Übersicht

SingleSignOn

Produktauswahlprozess

Abruf von Kriterien

Abruf der Gesamtbewertung

Beste Produkt am Markt

Indikation Produktqualität

Profilermittlung

enter/vertragscheck

Einsprung in fb-vertragscheck mit vordefiniertem Filter für das linke Produkt

Request

Endpoint: POST https://v7.fb-vertragscheck.fb-preview.de/external/enter/vertragscheck

Schema: GET https://v7.fb-vertragscheck.fb-preview.de/external/enter/vertragscheck/request/schema


property default description options
[ token ] * required
string
Ein gültiger Token für die Autentifizierung mit der Schnittstelle
[ pkfg ]
string
ID einer Produktkonfiguration
[ exit_url ]
string
URL, welche beim Verlassen des Tools per Redirect (HTTP 302) aufgerufen wird.
[ producttype ]
string
Kürzel einer Produktart die über die getproducttypes Schnittstelle abgerufen werden können
[ producttype_readonly ]
bool
Beschränkt die Auswahl im Tool auf den vorgegebenen Produktbereich
[ company_id ]
integer
ID einer Gesellschaft die über die getcompanies Schnittstelle abgerufen werden können (Alternativ: Übergabe einer Bafin-Nummer)
[ bafin ]
integer
Bafin-Nummer, anhand der die Gesellschaft vorausgewählt wird (falls company_id leer oder Null ist)
[ year ]
string
Jahr des Produktstandes für das eine Gesellschaft Produkte hat. Die gültigen Werte werden über die Schnittstelle getyears abgerufen.
[ mainproduct_id_version ]
string
Produkt ID und Version die über die getproducts Schnittstelle abgerufen werden kann
[ product_id_version ]
Produkt ID und Version die über die getproducts Schnittstelle abgerufen werden kann
[ productoptions ]
array
Produkt ID und Version der Optionen die über die getproductoptions abgerufen werden können
[ options ]
Produkt ID und Version der Optionen die über die getproductoptions abgerufen werden können
[ profile ]
string
ProfilID steuert die zurück gegebene Bewertung zu der Produktonfiguration (nur im Profil angegebene Kriterien werden für das Rating berücksichtigt)

object
Einstellungen für den Produktvergleich
property default description options
settings[ min_products ]
int
Minimale Anzahl nebeneinander vergleichbarer Produkte
settings[ max_products ]
int
Maximale Anzahl nebeneinander vergleichbarer Produkte
example:

mime-type: application/json, text/json

{
    "token": "a1s2d3f4g5h6j7k8l9",
    "pkfg": "10110110",
    "exit_url": "https:\/\/www.external-target.com\/",
    "producttype": "TYPE_BU",
    "producttype_readonly": true,
    "company_id": "1111",
    "bafin": "1090",
    "year": "2012",
    "mainproduct_id_version": "500_1",
    "productoptions": [
        "600_2"
    ],
    "profile": "11",
    "settings": {
        "min_products": "1",
        "max_products": "3"
    }
}
example:

mime-type: application/json, text/json

{
    "token": "a1s2d3f4g5h6j7k8l9"
}

Response

Schema: GET https://v7.fb-vertragscheck.fb-preview.de/external/enter/vertragscheck/response/schema


property description options
[ status ] * required
string
Status des Aufrufs
OK: Anfrage erfolgreich
ERROR: Anfrage verlief fehlerhaft
[ errors ]
array
Aufgetretene Fehler (Wird nur bei "status: ERROR" gefüllt!
[ accessurl ]
string
aufzurufende URL
example:

mime-type: application/json, text/json

{
    "status": "OK",
    "errors": [
        "Bitte geben Sie eine gültige Telefonnummer ein."
    ],
    "accessurl": "https:\/\/www.fb-vertragscheck.de\/..."
}