Allgemeine Informationen

Adresse

Sämtliche Schnittstellen sind unter folgender URL erreichbar:

https://api.versicherungsmarkt.de/{API-NAME}/{API-Type}?optionale_parameter=xyz

Im Header sind zudem je nach API folgende Angaben mitzusenden:

• Apikey (erhalten Sie von versicherungsmarkt.de)
• Makler (Ihre Makler-ID bei versicherungsmarkt.de)

Beispiel-Aufruf in PHP

Wir empfehlen zum Abruf der API eine serverseitige Lösung mit PHP.
Ein Beispiel-Skript könnte wie folgt aussehen:

<?php
//Angaben im Header
$header = array(
  'Apikey: ' . $MEIN_API_KEY,
  'makler: ' . $MEINE_MAKLER_ID,
);
//Zusätzliche Parameter
$parameter = array(
  'optionaler_parameter' => 'optionaler_wert'
);

// Connect API
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.versicherungsmrkt.de/NAME_DER_API/TYPE_DES_AUFRUFS");
curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($parameter));
$result = curl_exec($ch);
$result = json_decode($result, true);
curl_close($ch);
?>

Antwort

Alle-Schnittstellen liefern stets eine Antwort im JSON-Format. 
Die Antworten unterscheiden sich im Erfolgs- bzw. Fehlerfall.

Erfolgsfall

Rückgabewerte im Erfolgsfall:

{
    `success`: true,
    `data`:     {
            //Objekt mit den Ergebnis-Daten
            `bezeichnung`:    `wert‘,
            //usw.
            }
}

Fehlerfall

Rückgabewerte im Fehlerfall:

{
    `success`:    false,
    `error`:     [
                  "Fehlermeldung als String"
                  ]
}