Übersicht

SingleSignOn

Produktauswahlprozess

Abruf von Kriterien

Abruf der Gesamtbewertung

Beste Produkt am Markt

Indikation Produktqualität

Profilermittlung

get/comparisondocument

Ruft die Dokumentation anhand der übergebenen Produktkonfigurationen ab

Request

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

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


property default description options
[ token ] * required
string
Ein gültiger Token für die Autentifizierung mit der Schnittstelle.
[ pkfgs ]
array
Bis zu zwei IDs der zu vergleichenden Produktkonfigurationen. Übermittlung von "pkfgs" oder "products" zwingend erforderlich. Bei gleichzeitiger Übermittlung wird "products" verwendet und "pkfgs" ignoriert.
[ products ]
array
Eine Liste an Produkten mit den Feldern "pkfg" und optional "benefits_enabled" für eine Auswahl an OLMen oder "show_max_benefits=true" für alle OLMe. Übermittlung von "pkfgs" oder "products" zwingend erforderlich. Bei gleichzeitiger Übermittlung wird "products" verwendet und "pkfgs" ignoriert.
[ profile_id ] * required
string
ID des Bewertungsprofils
example:

mime-type: application/json, text/json

{
    "token": "a1s2d3f4g5h6j7k8l9",
    "pkfgs": [
        1000001,
        1000002
    ],
    "products": [
        {
            "pkfg": 123456789,
            "show_max_benefits": true,
            "benefits_enabled": [
                "fahrraddiebstahl"
            ]
        }
    ],
    "profile_id": "1223"
}
example:

mime-type: application/json, text/json

{
    "token": "a1s2d3f4g5h6j7k8l9",
    "profile_id": "1223"
}

Response

Schema: GET https://v7.fb-vertragscheck.fb-preview.de/external/get/comparisondocument/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!

array
Informationen zum Dateiabruf
property description options
protocoldata[ mime_type ]
string
MIME-Typ
protocoldata[ buffer ]
string
Buffer
protocoldata[ filename ]
string
Dateiname
protocoldata[ encoded ]
string
Codierung
example:

mime-type: application/json, text/json

{
    "status": "OK",
    "errors": [
        "Ungültiger Token."
    ],
    "protocoldata": [
        {
            "mime_type": "application\/pdf",
            "buffer": "AS3RDCFG5HZTFRBHJUZTFRD89SDFBH09NJH4G",
            "filename": "Tarifvergleich.pdf",
            "encoded": "base64"
        }
    ]
}