MailBeez.io API: Einfach und progressiv zu Implementieren

Einleitung

Bei der Konzeption der MailBeez.io API haben wir Erfahrungen aus der Implementierung von zahlreichen API-Anbindungen berücksichtigt: Viele API-Anbieter machen sich das Leben leicht und stellen lediglich Endpunkte zur Datenübergabe bereit - der Entwickler muss dann selbst Reihenfolge, Zeitpunkt und Ergebnis der Aufrufe dieser Endpunkte steuern, was zu deutlich erhöhter Komplexität führt.

Konzept

Schlanke Connector-Entwicklung

Die MailBeez API wurde nach folgenden Prinzipen konzeptioniert, um die Entwicklung der Connectoren möglichst einfach und leichgewichtig zu gestalten

• Keine komplexe Protokollierung von Abgleichvorgängen im Connector
• Einfach zu implementierende Webhook-Aufrufe
• Automatisierung ohne Cronjobs - MailBeez.io steuert den Abgleich

Da Implementierung von MailBeez-Connectoren so einfach wie möglich sein soll, übernimmt MailBeez.io die Steuerung der komplexen Abgleich-Prozesse. So mit muss der Entwickler lediglich Funktionen entwickeln, um Daten ein einem definierten Format bereit zu stellen.

Konkrekt bedeutet dies, dass je Resource (z.B. "Kunden", "Bestellungen") ist ein Endpunkt zu implemtieren ist, welche diese Daten auf Anforderung im beschriebenen Format über einen Webhook bereitstellt.

Beispiel: Übergabe von Kunden-Daten innerhalb des Webhooks

// load API Client
include('MBApiClient.php');

// you will receive these connection data from MailBeez.io
$host = 'http://myMailBeezUrl';
$user = 'myApiUser';
$pass = 'myApiPassword';

$mbApi = new MBApiClient($host, $user, $pass);

$dataArray = array(); // create array

// collect customer data from store database
$customers = getAllMyCustomers(); // here you retrieve all customer data

// loop through the result and add to $dataArray array
foreach ($customers as $customer) {
     $dataArray[] = array(
         "cID" => $customer['id'],
         "contact" => array(
             "email" => $customer['email_address'],
         )
     );
}

// pass the array with customers data to apiClient
$result = $mbApi->createCustomers($dataArray);

// done

Das vereinfachte Code-Beispiel zeigt, wie eine neue Instanz des MailBeez API Client MBApiClient() der Variablen $mbApi zugeordnet wird. Danach werden lediglich die Kunden-Daten gesammelt und schliesslich mit dem Aufruf $mbApi->createCustomers($dataArray) übertragen. Den Aufruf dieses Endpunktes steuert das MailBeez.io System. In der tatsächlichen Implementierung sind noch Parameter zu berücksichtigen, um die Ergebnis-Menge für die abschnittsweise Übertragung zu begrenzen (also z.B. übertrage Kunden von 200..300).

Progressiv: einfach anfangen und dann ausbauen

Um mit MailBeez.io starten zu können, sind nur wenige Endpunkte mit wenigen Pflicht-Angaben zu implentieren (z.B. "Kunden" -> Email-Adresse -> Newsletter-Versand). Progessiv können dann die weiteren Endpunkte für die API implementiert werden. Somit kann in kurzer Zeit eine Anbindung erstellt und getestet werden.

Dokumentation

Es empfiehlt sich, die komplette API zu lesen um so einen Überblick der Zusammenhänge zu erhalten.

• MailBeez REST API
  Vollständige Beschreibung der REST API
• MailBeez PHP API Client
  API Wrapper zur Vereinfachung der Implentierung von Connectoren

Der nette MailBeez.io Support hilft natürlich bei qualifizierten Fragen gerne weiter.

Jetzt Angebot anfordern