Übersicht

SingleSignOn

Produktauswahlprozess

Abruf von Kriterien

Abruf der Gesamtbewertung

Beste Produkt am Markt

Indikation Produktqualität

Profilermittlung

productselector/getbestproduct

Liefert die Produktkonfiguration mit der höchsten Bewertung für die angegebenen Daten und Bewertungsprofil.

Request

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

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


property default description options
[ token ] * required
string
Token zur Authentifizierung mit der Schnittstelle
[ producttype ] * required
string
Kurzform des Produkttyps (über Schnittstelle "/getproducttypes" zu erhalten)
[ company_id ] * required
integer
ID einer Gesellschaft (Über Schnittstelle "/getcompanies" zu erhalten)
[ profile ] * required
string
ID des anzuwendenden Bewertungsprofils
example:

mime-type: application/json, text/json

{
    "token": "a1s2d3f4g5h6j7k8l9",
    "producttype": "TYPE_HR",
    "company_id": 603,
    "profile": "11"
}
example:

mime-type: application/json, text/json

{
    "token": "a1s2d3f4g5h6j7k8l9",
    "producttype": "TYPE_HR",
    "company_id": 603,
    "profile": "11"
}

Response

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

object
Produktdaten
property description options
bestproduct[ pkfg ]
integer
Produktkonfigurations-ID
bestproduct[ name ]
string
Produktname
bestproduct[ company ]
string
Name der Gesellschaft
bestproduct[ percentage ]
integer
Erfüllungsgrad in Prozent

array
Produktdaten
property description options
products[ pkfg ]
integer
Produktkonfigurations-ID
products[ name ]
string
Produktname
products[ productname ]
string
Produktname Abkürzung
products[ product_id ]
integer
Interne ID des Produktes
products[ product_version ]
integer
Version des Produktes
example:

mime-type: application/json, text/json

{
    "status": "OK",
    "errors": [
        "Bitte geben Sie eine gültige Gesellschafts-ID ein."
    ],
    "bestproduct": {
        "pkfg": 123456789,
        "name": "Produktname",
        "company": "Pfefferminzia",
        "percentage": 79,
        "products": [
            {
                "pkfg": 987654321,
                "name": "Tarifname (lang)",
                "productname": "Tarifname (kurz)",
                "product_id": 1234,
                "product_version": 4
            }
        ]
    }
}