Übersicht

SingleSignOn

Produktauswahlprozess

Abruf von Kriterien

Abruf der Gesamtbewertung

Beste Produkt am Markt

Indikation Produktqualität

Profilermittlung

productsmodular/getbestproduct

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

Request

Endpoint: GET https://v7.fb-vertragscheck.fb-preview.de/external/productsmodular/getbestproduct

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


property default description options
[ token ] * required
string
Token zur Authentifizierung mit der Schnittstelle
[ producttype ] * required
string
Kurzform der Produktart (Über Schnittstelle "/getproducttypes" zu erhalten)
[ company_id ] * required
integer
ID einer Gesellschaft (/getcompanies)
[ profile ] * required
string
Bewertungsprofil
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/productsmodular/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!

array
Produktdaten
property description options
bestproduct[ pkfg ]
integer
Produktkonfigurations-Id
bestproduct[ name ]
string
Produktname
bestproduct[ gesellschaft ]
string
Name der Gesellschaft
bestproduct[ percentage ]
integer
Erfüllungsgrad in %

array
Produktdaten
property description options
products[ pkfg ]
integer
Produktkonfigurations-Id
products[ name ]
string
Produktname
products[ tarifname ]
string
Produktname Abkürzung
products[ produkt_id ]
integer
Interne ID des Produktes
products[ produkt_version ]
integer
Version des Produktes
example:

mime-type: application/json, text/json

{
    "status": "OK",
    "errors": [
        "Bitte geben Sie eine gültige Telefonnummer ein."
    ],
    "bestproduct": [
        {
            "pkfg": 123456789,
            "name": "Produktname",
            "gesellschaft": "Pfefferminzia",
            "percentage": 79,
            "products": [
                {
                    "pkfg": 987654321,
                    "name": "Tarifname (lang)",
                    "tarifname": "Tarifname (kurz)",
                    "produkt_id": 1234,
                    "produkt_version": 4
                }
            ]
        }
    ]
}