html - sesion - Crea un formulario básico de registro de MailChimp usando su API

mailchimp méxico

Question

Soy nuevo en MailChimp y necesito ayuda.

Con su formulario de suscripción al boletín de noticias básico ... simplemente inserta un poco de HTML preempaquetado en su página. Sin embargo, el problema con esto es que al hacer clic en Enviar redirige a una página de MailChimp. ( No quiero redireccionar a MailChimp, quiero que el usuario permanezca en su propio sitio web después de presionar enviar ) .

Proporcionan una API y mucha documentación, pero casi cero ejemplos útiles. Se supone que la API me permite hacer una integración completa con mi sitio o aplicación. Parece que cuando leo algo en sus documentos que se aplica a mí, hago clic en el enlace para obtener más información y termino dando vueltas en círculos. Te dicen cómo hacerlo, pero no pueden "mostrarte" cómo hacerlo.

Puedo obtener una clave de API, tienen toneladas de documentación y un montón de envoltorios y complementos ... PHP, Drupal, Wordpress, etc.

La confusión aquí con respecto a sus soluciones preempaquetadas es que solo tengo una página HTML estática regular, no es Wordpress, PHP o Drupal ... así que no sé por dónde empezar ... Ni siquiera sé si se supone que debo usar POST o GET .

No soy un novato en las API ... Lo hago muy bien con la API de Google Maps para hacer lo que quiera. Sin embargo, Google proporciona ejemplos de trabajo del mundo real además de su documentación detallada, que es la forma en que lo aprendí. Solo quiero verlo en acción antes de poder captar los puntos más finos de la API.

Sin ningún ejemplo sólido o tutorial en su documentación en línea, estoy preguntando cómo crear el formulario de registro HTML más básico usando su API.

Answer 1

Aquí hay otro ejemplo del uso de la versión 2.0 de la API de Mailchimp utilizando el HERE .

La diferencia entre mi ejemplo y otros publicados aquí es que estoy usando el método de subscribe de la clase Mailchimp_Lists , accesible a través de la creación de instancias de la clase Mailchimp ( ->lists ), en lugar del método de call genérica.

$api_key = "MAILCHIMP_API_KEY";
$list_id = "MAILCHIMP_LIST_ID";

require(''Mailchimp.php'');
$Mailchimp = new Mailchimp($api_key);
$subscriber = $Mailchimp->lists->subscribe($list_id, array(''email'' => $_POST[''email'']));

if ( ! empty($subscriber[''leid''])) {
    // Success
}

Answer 2

Aquí hay un ejemplo que usa la versión 2.0 de la API de Mailchimp junto con mailchimp-api (una clase mínima de abstracción php para tratar con la API de Mailchimp).

<?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
}

?>

Obtenga más información sobre lo que puede enviar con la llamada API en la documentación de la API de MailChimp .

Answer 3

EDITADO:

Desde publicar esta respuesta, MailChimp ha lanzado la versión 2 y 3 de su API. La versión 3 será la única versión admitida que comenzará en 2017. Tan pronto como tenga la oportunidad de probarla, actualizaré esta respuesta para la API versión 3.

MailChimp API v3.0

Según la notificación en la parte superior de esta página , todas las versiones anteriores de la API no serán compatibles después de 2016.

Mi solución usa PHP en segundo plano para manejar la API, y jQuery para facilitar el Ajax.

1) Descargue un envoltorio PHP que admita API v3.0. Al escribir estas líneas, no hay nada oficial en la lista de los últimos documentos de MailChimp que admite v3.0, pero varios están listados en GitHub, así que seleccioné este .

2) Cree el siguiente archivo PHP, store-address.php , usando su propia clave API y su ID de lista, y luego colóquelo en el mismo directorio que el contenedor desde el primer paso. Recuerde seguir la documentación de su envoltorio, pero todos parecen bastante similares a esto.

<?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) Cree su formulario HTML / CSS / JavaScript (jQuery) ( No es necesario que esté en una página PHP, y el visitante nunca verá que PHP se está usando en segundo plano ) .

La respuesta está en JSON, así que tendrás que manejarlo correctamente.

Aquí está mi archivo 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 versión 1:

( respuesta original )

Después de buscar por un rato, encontré un sitio usando el ejemplo de PHP con jQuery. A partir de eso, pude crear una página HTML simple con jQuery que contiene el formulario básico de registro. Los archivos PHP están "ocultos" en el fondo donde el usuario nunca los ve, pero jQuery todavía puede acceder y usar.

1) Descargue el ejemplo de PHP 5 jQuery aquí ... ( EDITAR : los enlaces están muertos. Sin embargo, la única parte importante es el envoltorio API oficial para PHP que está disponible HERE ).

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

Si solo tiene PHP 4, simplemente descargue la versión 1.2 de MCAPI y reemplace el archivo correspondiente MCAPI.class.php anterior.

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

2) Siga las instrucciones en el archivo Léame agregando su clave API e ID de lista al archivo store-address.php en las ubicaciones correctas.

3) También es posible que desee recopilar el nombre de sus usuarios u otra información. Debe agregar una matriz al archivo store-address.php usando las correspondientes variables de combinación.

Esto es lo que parece mi archivo store-address.php donde también reúno el nombre, apellido y tipo de correo electrónico:

<?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) Crea tu formulario HTML / CSS / jQuery. No es necesario estar en una página PHP.

Aquí está mi archivo 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>

Piezas requeridas ...

• index.html construido como arriba o similar. Con jQuery, la apariencia y las opciones son infinitas.

• store-address.php archivo descargado como parte de ejemplos de PHP en el sitio Mailchimp y modificado con su API KEY y LIST ID . Necesita agregar sus otros campos opcionales a la matriz.

• Archivo MCAPI.class.php descargado del sitio de Mailchimp (versión 1.3 para PHP 5 o versión 1.2 para PHP 4). Colóquelo en el mismo directorio que su store-address.php o debe actualizar la ruta url dentro de store-address.php para que pueda encontrarlo.