Creamailerin API SDK PHP:lle

Creamailerista löytyy valmis SDK-kirjasto PHP:lle, joka nopeuttaa integraation rakentamista merkittävästi. Kirjaston avulla esimerkiksi yhteyden muodostaminen ja tilaajan lisäys Creamailerin postituslistalle onnistuu muutamassa minuutissa. Kirjaston GitHub-sivu löytyy tästä.

Asentaminen

Kirjasto voidaan asentaa käyttäen Composeria.

composer require creamailer/creamailer-api-sdk

Asennuksen jälkeen:

Jos projektissa ei ole valmiiksi käytössä autoloaderia, se tulee lisätä rivillä: require("vendor/autoload.php")

Yhteyden muodostaminen

Yhteyden muodostamista varten tarvitaan CREAMAILER_ACCESS_TOKEN ja CREAMAILER_SHARED_SECRET API-avaimet. Ne voidaan luoda Creamailerin ylläpidosta oman käyttäjätunnuksen alta kohdasta Asetukset ja valitsemalla API.

Esimerkki:

use Creamailer\Creamailer;

$creamailer = new Creamailer(YOUR_CREAMAILER_ACCESS_TOKEN, YOUR_CREAMAILER_SHARED_SECRET);

Yhteyden testaus

Yhteys voidaan testata käyttämällä kirjastosta löytyvää ping-metodia.

$result = $creamailer->ping();

if ( ! $result->success) {
    echo 'Error: ' . $result->message;
}

print_r($result);

Tilaajan lisääminen listalle

Tilaajan lisäystä varten tarvitaan listan tunniste (ID). Katso ohje tunnisteen hakemiseen.

$listId = 1234;
$email = 'name@example.com';
$name = 'Firstname Lastname';
$company = 'Company Name';
$address = 'Street 1';
$city = 'Helsinki';
$zip_code = '00100';
$country = 'Finland';
$phone = '040123456';
$customer_number = '1234';
$send_autoresponders = true;
$send_autoresponders_if_exists = true;
$status = 'active';

// Personoidut kentät
$some_custom_field = 'some extra info';

$result = $creamailer->subscribers()->create(
    $listId,
    [
        'email' => $email,
        'name' => $name,
        'company' => $company,
        'address' => $address,
        'company' => $company,
        'city' => $city,
        'zip_code' => $zip_code,
        'country' => $country,
        'phone' => $phone,
        'customer_number' => $customer_number,
        'send_autoresponders' => $send_autoresponders,
        'send_autoresponders_if_exists' => $send_autoresponders_if_exists,
        'status' => $status,
        'custom_fields' => [
            'some_custom_field' => $some_custom_field
        ]
    ]
);

print_r($result);

Huom. personoituja kenttiä (custom_fields) tulee käyttää vain jos niitä on lisätty postituslistalle. Muussa tapauksessa kyseinen kohta kannattaa poistaa.

Lisää esimerkkejä Creamailerin API SDK -kirjaston käytöstä löytyy sen GitHub-sivulta.