Individuelle Integration (php)

Die Integration der RatingChamp-Schnittstelle lässt sich in nahezu jede Software vornehmen. In diesem Beispiel erklären wir Ihnen die Grundlagen wie Sie dieses am besten durchführen.

Es ist unablässlich, dass Sie Bestellungen die in Ihrer Software eingehen an unsere Schnittstelle melden. Dieses muss automatisiert geschehen, idealerweise zu dem Zeitpunkt an dem die Ware versendet wurde.

Dieses können Sie realisieren, indem Sie folgende php-Funktion in Ihre Software einbinden und mit den passenden Parametern aufrufen:

    function notifiy_ratingchamp($firstname,$lastname,$g='m',$mail,$order_id,$lang,$date){

        $order_data = array();

        // Bestellnummer
        $order_data['merchant_orders_id']= $order_id;

        // Vorname des Kunden
        $order_data['customers_firstname']= $firstname;

        // Nachname des Kunden
        $order_data['customers_lastname']= $lastname;

        // Geschlecht des Kunden (benötigt für die korekte Ansprache in den Mails)
        $order_data['customers_gender']= $g;

        // Mail-Adresse des Kunden
        $order_data['customers_email_address']= $mail;

        // Sprache in der die Bestellung durchgeführt wurde
        $order_data['orders_language']= $lang;    

        // Datum der Bestellung
        $order_data['orders_date']= $date;

        $data_string = json_encode($order_data);

        $ch = curl_init('https://api.ratingchamp.com/api/public/order');
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
        curl_setopt($ch, CURLOPT_USERPWD, RATINGCHAMP_API_ACCOUNT_KEY . ":" . RATINGCHAMP_API_PW);
        curl_setopt($ch, CURLOPT_POSTFIELDS, $data_string);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_HTTPHEADER, array(
                'Content-Type: application/json',
                'Content-Length: ' . strlen($data_string))
        );
        $result = curl_exec($ch);

        $result = json_decode($result);

        if ($result->code=='200') {       	
			// everything ok, order submitted        	
        } else {
        	// show error
        	echo $result->message;
        }

    }

Beachten Sie, dass Sie die RATINGCHAMP_API_ACCOUNT_KEY & RATINGCHAMP_API_PW zuvor mit den RatingChamp API-Daten aus Ihrem Account definiert werden müssen.

Diese Funktion sollten Sie idealerweise aufrufen, wenn der Bestellstatus einer Bestellung den Versand der Ware kennzeichnet.

Alternativ besteht natürlich auch die Möglichkeit täglich ein Script (z.B. per Cronjob) auszuführen, welches die Bestellungen des Vortags mit Hilfe der Funktion an unseren Service überträgt.

In letzterem Falle sollten Sie sicherstellen, dass Bestellungen die an unseren Service übermittelt worden gekennzeichnet werden, damit es zu keinen Problemen kommt.

Beispielantworten bei Fehlerhafter übermittlung

Falsche API Zugangsdaten

{
    "code": "500",
    "status": "error",
    "message": "Authentication failed"
}

Maximale Anzahl an Bestellungen überschritten (je nach Tarif)

{
    "code": 501,
    "message": "max quota exceeded",
    "max_quota": null
}

Fehlerhate Daten übertragen (vergessene Felder etc)

{
  "code": 502,
  "message": "Invalid data",
  "errors": {
    "order": [
      {
        "field": "merchant_orders_id",
        "message": "merchant_orders_id already exists"
      }
    ]
  }
}

 

Individuelle Widget-Integration:

Das Widget lässt sich sehr flexibel in Ihren Shop integrieren, es muss lediglich folgende Zeile vor dem schließenden Body-Tag (</body>) eingebunden werden:

<script type="text/javascript" src="http://widget.ratingchamp.com/xxxxxx.js"></script>

Ersetzen Sie das xxxxxx in der Zeile mit Ihrem API-Key, den Sie auch in der gleichnamigen Option eingetragen haben.

Danach fügen Sie an der Stelle in der Sie das Siegel oder Widget anzeigen wollen folgenden Code ein:

<!-- RatingChampWidget START -->
<div class="RatingChampWidget sidebar-box">
<a href="http://RatingChamp.de" rel="nofollow" target="_blank">RatingChamp geprüfter Shop</a>
</div>
<!-- RatingChampWidget END -->

War diese Antwort hilfreich?

 Artikel drucken

Lesen Sie auch

xt:Commerce 4

Erfahren Sie in folgender Anleitung wie Sie RatingChamp in Ihren xt:Commerce 4 Shop integrieren:...

xt:Commerce v3.0.4 SP2.1

Erfahren Sie in folgender Anleitung wie Sie RatingChamp in Ihren xt:Commerce v3.0.4 SP2.1 Shop...

Modified Shop (bis Version 1.06)

Erfahren Sie in folgender Anleitung wie Sie RatingChamp in Ihren die "modified...

Modified Shop (ab V. 2.0)

Erfahren Sie in folgender Anleitung wie Sie RatingChamp in Ihren die "modified...

WooCommerce / Wordpress

Systemanforderungen: WordPress (ab Version 3.0.0) WooCommerce (ab Version 2.1.6)...