web-dev-qa-db-ja.com

APIを使用して基本的なMailChimpサインアップフォームを作成する

私はMailChimpが初めてなので、助けが必要です。

基本的なニュースレター登録フォームを使用すると、事前にパッケージ化されたHTMLをページに埋め込むだけです。ただし、これに関する問題は、送信をクリックするとMailChimpページにリダイレクトされることです。 （MailChimpにリダイレクトしたくないので、送信後にユーザーが自分のWebサイトに留まるようにしたい。）

APIと多くのドキュメントを提供しますが、有用な例はほとんどありません。このAPIにより、サイトまたはアプリケーションとの完全な統合が可能になります。自分のドキュメントで自分に当てはまるものを読んだとき、リンクをクリックして詳細情報を取得すると、円になってしまいます。彼らはあなたにそれをする方法を教えますが、彼らはあなたにそれをどのように「見せ」ません。

APIキーを取得できます。多くのドキュメントがあり、ラッパーとプラグインがたくさんあります。PHP、Drupal、Wordpressなどです。

あらかじめパッケージ化されたソリューションに関するここでの混乱は、Wordpress、PHP、またはDrupalではなく、通常の静的なHTMLページがあるだけだということです...だから私はどこから始めればいいのかわかりません...私も知りませんPOSTまたはGETを使用することになっている場合。

私はAPIの初心者ではありません... Google Maps APIを使って、私がやりたいことを何でもできるようにしています。ただし、Googleは詳細なドキュメントに加えて実際の実例を提供しています。 APIのより細かい点を把握する前に、実際に動作を見たいだけです。

オンラインドキュメントに具体的な例やチュートリアルがなければ、APIを使用して最も基本的なHTMLサインアップフォームを作成する方法を尋ねています。

htmlajaxmailchimpmailchimp-api-v3.0
73
Sparky

編集済み：

この回答を投稿してから、MailChimpはAPIのバージョン2および3をリリースしました。バージョン3は、2017年からサポートされる唯一のバージョンです。テストの機会があり次第、APIバージョン3のこの回答を更新します。

MailChimp API v3.0

このページの上部の通知に従って 、以前のバージョンのAPIはすべて2016年以降サポートされません。

私のソリューションでは、バックグラウンドでPHPを使用してAPIを処理し、jQueryを使用してAjaxを促進します。

1）API v3.0をサポートするPHPラッパーをダウンロードします。この記事の執筆時点では、v3.0をサポートする最新のMailChimpドキュメントには公式のリストはありませんが、GitHubにリストされているものがあるため、 this one を選択しました。

2）独自のAPIキーとリストIDを使用して、次のPHPファイル、store-address.phpを作成し、ステップ1のラッパーと同じディレクトリに配置します。ラッパーのドキュメントに従うことを忘れないでください。しかし、これらはすべてこれとかなり似ているようです。

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

（元の回答）

しばらく手探りした後、jQueryでPHPの例を使用してサイトを見つけました。それから、基本的なサインアップフォームを含むjQueryで簡単なHTMLページを作成できました。 PHPファイルはバックグラウンドで「隠され」ており、ユーザーには表示されませんが、jQueryは引き続きアクセスおよび使用できます。

1）PHP 5 jQueryの例をこちらからダウンロードしてください...（[〜＃〜] edit [〜＃〜]：リンクしかし、唯一の重要な部分は、[ [〜＃〜] here [〜＃〜] で利用可能なPHPの公式APIラッパーです。）

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

PHP 4しかない場合は、バージョン1.2のMCAPIをダウンロードして、上記の対応するMCAPI.class.phpファイルを置き換えるだけです。

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

2）APIキーとリストIDを適切な場所のstore-address.phpファイルに追加して、Readmeファイルの指示に従います。

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 MailchimpサイトのPHPの例の一部としてダウンロードされ、 APIキー そして リストID。他のオプションのフィールドを配列に追加する必要があります。

  • MCAPI.class.php Mailchimpサイトからダウンロードしたファイル（PHP 5の場合はバージョン1.3、PHP 4の場合はバージョン1.2）。あなたと同じディレクトリに置きます store-address.php または、内のURLパスを更新する必要があります store-address.php 見つけることができます。

68
Sparky

以下に、Mailchimp APIのversion 2.0と 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ドキュメント をご覧ください。

20
Jonas Äppelgran

Official PHP Wrapper を使用してバージョン2.0のMailchimp APIを使用する別の例を次に示します。

私の例とここに投稿された他の例との違いは、 SubscribeMailchimp_Lists クラスのメソッドを使用していることです。Mailchimpクラス（->lists）、一般的な call メソッドではなく。

$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
}
7
davidnknight