Создайте базовую форму регистрации в MailChimp, используя их API - PullRequest
73 голосов
/ 17 февраля 2011

Я новичок в MailChimp и мне нужна помощь.

С их базовой формой подписки на новостную рассылку ... вы просто вставляете предварительно упакованный HTML на свою страницу Однако проблема заключается в том, что нажатие на кнопку «Отправить» перенаправляет на страницу MailChimp. ( Я не хочу перенаправлять на MailChimp, я хочу, чтобы пользователь оставался на своем веб-сайте после нажатия кнопки "Отправить". )

Они предоставляют API и множество документации, но практически нулевых полезных примеров. Предполагается, что API позволит мне полностью интегрироваться с моим сайтом или приложением. Кажется, что когда я читаю в их документах что-то, что относится ко мне, я нажимаю на ссылку, чтобы получить больше информации, и в итоге я иду по кругу. Они говорят вам, как это сделать, но не могут «показать» вам, как это сделать.

Я могу получить ключ API, у него есть тонна документации и целая куча обёрток и плагинов ... PHP, Drupal, Wordpress и т. Д ...

Путаница в отношении их готовых решений заключается в том, что у меня просто есть обычная статическая HTML-страница, это не Wordpress, PHP или Drupal ... поэтому я просто не знаю, с чего начать ... Я даже не знаю, должен ли я использовать POST или GET.

Я не новичок в API ... Я очень хорошо заставляю API Карт Google делать все, что захочу. Тем не менее, Google предоставляет реальные рабочие примеры в дополнение к их подробной документации, как я и узнал. Я просто хочу увидеть его в действии, прежде чем смогу понять тонкости API.

Без каких-либо убедительных примеров или руководств в их онлайн-документации я спрашиваю, как создать основную форму регистрации в HTML, используя их API.

Ответы [ 3 ]

66 голосов
/ 20 февраля 2011

РЕДАКТИРОВАНИЕ:

С момента публикации этого ответа MailChimp выпустила версии 2 и 3 своего API. Версия 3 будет единственной поддерживаемой версией, начиная с 2017 года. Как только у меня появится возможность протестировать ее, я обновлю этот ответ для API версии 3.


MailChimp API v3.0

В соответствии с уведомлением вверху этой страницы все предыдущие версии API не будут поддерживаться после 2016 года.

Мое решение использует PHP в фоновом режиме для обработки API и jQuery для облегчения Ajax.

1) Загрузите оболочку PHP, поддерживающую API v3.0. На момент написания этой статьи в последних документах MailChimp, поддерживающих v3.0, не было ничего официального, но некоторые из них перечислены в GitHub, поэтому я выбрал this .

2) Создайте следующий файл PHP, store-address.php, используя свой собственный ключ API и идентификатор списка, а затем поместите его в тот же каталог, что и оболочка, начиная с первого шага. Не забудьте следовать документации для вашей обертки, но все они кажутся довольно похожими на это.

<?php // for MailChimp API v3.0

include('MailChimp.php');  // path to API wrapper downloaded from GitHub

use \DrewM\MailChimp\MailChimp;

function storeAddress() {

    $key        = "xxxxxxxxxxxxxxx-us1";
    $list_id    = "xxxxxx";

    $merge_vars = array(
        'FNAME'     => $_POST['fname'],
        'LNAME'     => $_POST['lname']
    );

    $mc = new MailChimp($key);

    // add the email to your list
    $result = $mc->post('/lists/'.$list_id.'/members', array(
            'email_address' => $_POST['email'],
            'merge_fields'  => $merge_vars,
            'status'        => 'pending'     // double opt-in
            // 'status'     => 'subscribed'  // single opt-in
        )
    );

    return json_encode($result);

}

// If being called via ajax, run the function, else fail

if ($_POST['ajax']) { 
    echo storeAddress(); // send the response back through Ajax
} else {
    echo 'Method not allowed - please ensure JavaScript is enabled in this browser';
}

3) Создайте форму HTML / CSS / JavaScript (jQuery) ( Не обязательно находиться на странице PHP, и посетитель никогда не увидит, что PHP используется в фоновом режиме. )

Ответ находится в формате JSON, поэтому вам придется обрабатывать его правильно.

Вот как выглядит мой index.html файл:

<form id="signup" action="index.html" method="get">
    First Name: <input type="text" name="fname" id="fname" />
    Last Name: <input type="text" name="lname" id="lname" />
    email Address (required): <input type="email" name="email" id="email" />
    <input type="submit" id="SendButton" name="submit" value="Submit" />
</form>
<div id="message"></div>

<script src="jquery.min.js"></script>
<script>
$(document).ready(function() {
    $('#signup').submit(function() {
        $("#message").html("Adding your email address...");
        $.ajax({
            url: 'inc/store-address.php', // proper url to your "store-address.php" file
            type: 'POST', // <- IMPORTANT
            data: $('#signup').serialize() + '&ajax=true',
            success: function(msg) {
                var message = $.parseJSON(msg),
                    result = '';
                if (message.status === 'pending') { // success
                    result = 'Success!  Please click the confirmation link that will be emailed to you shortly.';
                } else { // error
                    result = 'Error: ' + message.detail;
                }
                $('#message').html(result); // display the message
            }
        });
        return false;
    });
});
</script>

MailChimp API версия 1:

( оригинальный ответ )

Поработав некоторое время, я нашел сайт, использующий пример PHP с jQuery. После этого мне удалось создать простую HTML-страницу с jQuery, содержащую базовую форму регистрации. Файлы PHP «спрятаны» в фоновом режиме, где пользователь их никогда не видит, но jQuery все еще может получить к ним доступ и использовать.

1) Загрузите пример PHP 5 jQuery здесь ... ( EDIT : ссылки не работают. Однако единственной важной частью является официальная оболочка API для PHP, которая доступна ЗДЕСЬ .)

http://apidocs.mailchimp.com/downloads/mcapi-simple-subscribe-jquery.zip

Если у вас только PHP 4, просто загрузите MCAPI версии 1.2 и замените соответствующий MCAPI.class.php файл выше.

http://apidocs.mailchimp.com/downloads/mailchimp-api-class-1-2.zip

2) Следуйте инструкциям в файле Readme, добавив ключ API и идентификатор списка в файл store-address.php в соответствующих местах.

3) Возможно, вы также захотите собрать имя пользователя и / или другую информацию. Вы должны добавить массив в файл store-address.php, используя соответствующие переменные слияния.

Вот как выглядит мой store-address.php файл, где я также собираю имя, фамилию и тип электронной почты:

<?php

function storeAddress() {

    require_once('MCAPI.class.php');  // same directory as store-address.php

    // grab an API Key from http://admin.mailchimp.com/account/api/
    $api = new MCAPI('123456789-us2');

    $merge_vars = Array( 
        'EMAIL' => $_GET['email'],
        'FNAME' => $_GET['fname'], 
        'LNAME' => $_GET['lname']
    );

    // grab your List's Unique Id by going to http://admin.mailchimp.com/lists/
    // Click the "settings" link for the list - the Unique Id is at the bottom of that page. 
    $list_id = "123456a";

    if ($api->listSubscribe($list_id, $_GET['email'], $merge_vars , $_GET['emailtype'])) {
        // It worked!   
        return 'Success!&nbsp; Check your inbox or spam folder for a message containing a confirmation link.';
    } else {
        // An error ocurred, return error message   
        return '<b>Error:</b>&nbsp; ' . $api->errorMessage;
    }

}

// If being called via ajax, autorun the function
if($_GET['ajax']) { 
    echo storeAddress(); 
}

4) Создайте форму HTML / CSS / jQuery. Не обязательно быть на странице PHP.

Вот как выглядит мой index.html файл:

<form id="signup" action="index.html" method="get">
    First Name: <input type="text" name="fname" id="fname" />
    Last Name: <input type="text" name="lname" id="lname" />
    email Address (required): <input type="email" name="email" id="email" />
    HTML: <input type="radio" name="emailtype" value="html" checked="checked" />
    Text: <input type="radio" name="emailtype" value="text" />
    <input type="submit" id="SendButton" name="submit" value="Submit" />
</form>
<div id="message"></div>

<script src="jquery.min.js"></script>
<script>
$(document).ready(function() {
    $('#signup').submit(function() {
        $("#message").html("Adding your email address...");
        $.ajax({
            url: 'inc/store-address.php', // proper url to your "store-address.php" file
            data: $('#signup').serialize() + '&ajax=true',
            success: function(msg) {
                $('#message').html(msg);
            }
        });
        return false;
    });
});
</script>

Требуется штук ...

  • index.html сконструирован как указано выше или аналогичный. С jQuery внешний вид и опции бесконечны.

  • store-address.php , загруженный как часть примеров PHP на сайт Mailchimp и измененный с помощью API KEY и LIST ID . Вам нужно добавить другие дополнительные поля в массив.

  • MCAPI.class.php файл, загруженный с сайта Mailchimp (версия 1.3 для PHP 5 или версия 1.2 для PHP 4). Поместите его в тот же каталог, что и ваш store-address.php , или вы должны обновить путь URL в store-address.php , чтобы он мог его найти.

20 голосов
/ 18 сентября 2013

Вот пример использования версии 2.0 Mailchimp API вместе с mailchimp-api (минимальный класс абстракции php для работы с Mailchimp API).

<?php

include('MailChimp.php');

$MailChimp = new MailChimp('API_KEY');
$result = $MailChimp->call('lists/subscribe', array(
    'id'                => 'LIST_ID',
    'email'             => array( 'email' => $_POST['email'] ),
    'merge_vars'        => array(
        'MERGE2' => $_POST['name'] // MERGE name from list settings
        // there MERGE fields must be set if required in list settings
    ),
    'double_optin'      => false,
    'update_existing'   => true,
    'replace_interests' => false
));

if( $result === false ) {
    // response wasn't even json
}
else if( isset($result->status) && $result->status == 'error' ) {
    // Error info: $result->status, $result->code, $result->name, $result->error
}

?>

Подробнее о том, что можно отправить с помощью вызова API, можно узнать из Документация по MailChimp API .

7 голосов
/ 05 декабря 2013

Вот еще один пример использования версии 2.0 API Mailchimp с использованием Официального PHP Wrapper .

Разница между моим примером и другими, опубликованными здесь, в том, что я использую подписаться метод класса Mailchimp_Lists , доступный через создание экземпляра класса Mailchimp (->lists), а не общий вызов метод.

...