mailchimp中文文档|mailchimp js中文教程|解析

npm npmdoc 2年前 (2021-12-28) 515次浏览

mailchimp中文文档|mailchimp js中文教程|解析

安装命令:npm i mailchimp

节点邮件黑猩猩

MailChimp API 的 node.js 包装器。

node-mailchimp向您的 node.js 应用程序公开 MailChimp API 的以下功能:

  • MailChimp API(版本 2.0、1.3、1.2 和 1.1)
  • MailChimp 导出 API(1.0 版)
  • MailChimp 网络钩子
  • MailChimp OAuth2 授权
  • MailChimp 合作伙伴 API(版本 1.3)
  • Mandrill API(版本 1.0)

有关 MailChimp API 及其功能的更多信息,请访问http://apidocs.mailchimp.com如果您想了解有关 Mandrill API 及其功能的更多信息,查看https://mandrillapp.com/api/docs/

目录

安装

使用 npm(节点包管理器)安装:

npm install mailchimp

如果你没有安装 npm 或者不想使用它:

cd ~/.node_libraries
git clone git://github.com/gomfunkel/node-mailchimp.git mailchimp

请注意,部分节点mailchimp依赖于要求通过Mikeal罗杰斯需要安装此库才能使 API 和导出 API 正常工作。此外,Webhooks 需要node-querystring才能工作。如果您使用 npm,所有依赖项都应该自动为您解析。

用法

可以在下面找到有关如何使用 MailChimp API 的信息。有关可用 API 方法的更多信息,请访问http://apidocs.mailchimp.com您还可以在 MailChimp API 页面上找到有关如何获取 API 密钥、如何在您的 MailChimp 帐户中设置 Webhooks 和/或 OAuth2 的更多信息。

所述MailChimp API的一些方法中采取的关联数组作为参数,例如参数merge_vars的的listSubscribe方法。由于 JavaScript 中没有关联数组,您只需使用其属性作为键的对象,如下例所示:

var merge_vars = {
    EMAIL: '/* E-MAIL ADDRESS */',
    FNAME: '/* FIRST NAME */',
    LNAME: '/* LAST NAME */'
};

MailChimp API(使用 MailChimp API 2.0 版时)

注意:对 MailChimp API v2.0 的支持尚未经过充分测试。请谨慎使用。如有疑问,请坚持使用旧版本的 API (v1.x) 并跳至下一章以获取文档。

MailChimpAPI有两个参数。第一个参数是您的 API 密钥,您可以在您的 MailChimp 帐户中找到它。第二个参数是一个选项对象,它可以包含以下选项:

  • version要使用的 API 版本(1.1、1.2、1.3 或 2.0)。默认为 1.3。确保在此处明确使用 2.0 或参考下一章有关旧 API 版本的文档。
  • userAgent 要在请求标头中使用的自定义用户代理描述。

MailChimp API v2.0 文档(http://apidocs.mailchimp.com/api/2.0描述的所有 API 类别和方法都可以在此包装器中找到。要使用它们,使用的方法call需要四个参数:

  • section 要调用的 API 方法部分(例如“campaigns”)。
  • method 在给定部分中调用的方法。
  • params 传递给 API 方法的参数。
  • callback带有两个参数的返回数据或错误的回调函数。第一个是一个错误对象,当没有发生错误时它为空,第二个是一个对象,只要没有发生错误,就会检索所有信息。

例子:

var MailChimpAPI = require('mailchimp').MailChimpAPI;
 
var apiKey = 'Your MailChimpAPI API Key';
 
try {
    var api = new MailChimpAPI(apiKey, { version : '2.0' });
} catch (error) {
    console.log(error.message);
}
 
api.call('campaigns', 'list', { start: 0, limit: 25 }, function (error, data) {
    if (error)
        console.log(error.message);
    else
        console.log(JSON.stringify(data)); // Do something with your data!
});
 
api.call('campaigns', 'template-content', { cid: '/* CAMPAIGN ID */' }, function (error, data) {
    if (error)
        console.log(error.message);
    else
        console.log(JSON.stringify(data)); // Do something with your data!
});

MailChimp API(使用 MailChimp API 1.x 版时)

MailChimpAPI有两个参数。第一个参数是您的 API 密钥,您可以在您的 MailChimp 帐户中找到它。第二个参数是一个选项对象,它可以包含以下选项:

  • version要使用的 API 版本(1.1、1.2、1.3 或 2.0)。默认为 1.3。
  • secure是否通过 HTTPS 使用安全连接 (true/false)。默认为假。
  • userAgent 要在请求标头中使用的自定义用户代理描述。

每个 API 方法的回调函数都有两个参数。第一个是一个错误对象,当没有发生错误时它为空,第二个是一个对象,只要没有发生错误就检索所有信息。

例子:

var MailChimpAPI = require('mailchimp').MailChimpAPI;
 
var apiKey = 'Your MailChimp API Key';
 
try {
    var api = new MailChimpAPI(apiKey, { version : '1.3', secure : false });
} catch (error) {
    console.log(error.message);
}
 
api.campaigns({ start: 0, limit: 25 }, function (error, data) {
    if (error)
        console.log(error.message);
    else
        console.log(JSON.stringify(data)); // Do something with your data!
});
 
api.campaignStats({ cid : '/* CAMPAIGN ID */' }, function (error, data) {
    if (error)
        console.log(error.message);
    else
        console.log(JSON.stringify(data)); // Do something with your data!
});

MailChimp 导出 API

MailChimpExportAPI有两个参数。第一个参数是您的 API 密钥,您可以在您的 MailChimp 帐户中找到它。第二个参数是一个选项对象,它可以包含以下选项:

  • version要使用的导出 API 版本,目前只有 1.0 可用和受支持。默认为 1.0。
  • secure是否通过 HTTPS 使用安全连接 (true/false)。默认为假。
  • userAgent 要在请求标头中使用的自定义用户代理描述。

每个 API 方法的回调函数都有两个参数。第一个是一个错误对象,当没有发生错误时它为空,第二个是一个对象,只要没有发生错误就检索所有信息。

例子:

var MailChimpExportAPI = require('mailchimp').MailChimpExportAPI;
 
var apiKey = 'Your MailChimp API Key';
 
try {
    var exportApi = new MailChimpExportAPI(apiKey, { version : '1.0', secure: false });
} catch (error) {
    console.log(error.message);
}
 
exportApi.list({ id : '/* LIST ID */'  }, function (error, data) {
    if (error)
        console.log(error.message);
    else
        console.log(JSON.stringify(data)); // Do something with your data!
});

MailChimp 网络钩子

MailChimpWebhook接受一个参数,一个包含以下选项的选项对象:

  • port服务器将要侦听的端口。默认为 8100。
  • secretWebhook 页面上建议的密钥,然后只需将其作为路径名添加到您的 MailChimp 帐户中的 Webhook URL 并进行检查。没有什么太花哨的,但对安全性的小幅增强。如果您不想使用密钥,请留空(默认设置)。示例:如果您将机密设置为“ChimpSecret”,则需要在 MailChimp Webhook 设置中输入 Webhook URL http://www.yourdomain.com/ChimpSecret
  • secure由加密模块生成的凭据。如果存在,则为服务器启用了 HTTPS 支持。默认为假。

您可以注册以下事件。每个事件的回调函数接收两个参数。第一个参数是检索信息的对象,第二个参数包含事件发生时间等元数据。

  • subscribe 当有人订阅您的列表时发出。
  • unsubscribe 当有人取消订阅您的列表时发出。
  • profile 当有人更新他的个人资料时发出。
  • upemail当有人更改他的电子邮件地址时发出。请注意,您将同时收到一个profile事件。
  • cleaned 从您的列表中清除电子邮件地址时发出。
  • campaign 当为您的列表发送活动时发出。

例子:

var MailChimpWebhook = require('mailchimp').MailChimpWebhook;
 
var webhook = new MailChimpWebhook();
 
webhook.on('error', function (error) {
    console.log(error.message);
});
 
webhook.on('subscribe', function (data, meta) {
    console.log(data.email+' subscribed to your newsletter!'); // Do something with your data!
});
 
webhook.on('unsubscribe', function (data, meta) {
    console.log(data.email+' unsubscribed from your newsletter!'); // Do something with your data!
});

MailChimp OAuth2

MailChimpOAuth接受一个参数,一个选项对象,它可以包含以下选项:

  • clientIdclientId 可以从 MailChimp 获取,请参阅 API 文档以了解如何执行此操作。clientId 是必需参数。
  • clientSecretclientSecret 可以从 MailChimp 获取,请参阅 API 文档以了解如何执行此操作。clientSecret 是必需参数。
  • redirectUri 从 MailChimp 应用程序配置重定向 URI
  • ownServer布尔值以启用自己的自定义服务器以侦听重定向 URI。默认为假。
  • addPort 在 redirectUri 中添加端口号值的布尔值默认为 false。
  • port服务器将要侦听的端口。默认为 8100。如果 ownServer 为 false,则不需要这些字段
  • finalUri 在 MailChimp 网站上成功授权后,用户将被重定向到此 URI(如果有)。
  • secure形式为 {key:path to ssl key file, cert: path to ssl certificate file} 的凭证。如果存在,则为服务器启用了 HTTPS 支持。默认为假。

您可以注册以下事件:

  • error 当发生错误并接收一个包含错误消息的参数时,会发出此事件。
  • authed当 OAuth 成功完成时发出。接收一个参数,该参数表示自定义对象中的 API 密钥,元数据可以传递给其他 API 功能。

例子:

var MailChimpOAuth = require('mailchimp').MailChimpOAuth;
var MailChimpAPI = require('mailchimp').MailChimpAPI;
 
var options = {
    clientId: 'Your MailChimp client id',
    clientSecret: 'Your MailChimp client secret',
    redirectUri: 'http://www.example.com',
    ownServer: true,
    addPort: true,
    finalUri: 'http://www.example.com/successfulLogin.html'
};
 
var oauth = new MailChimpOAuth(options);
 
console.log(oauth.getAuthorizeUri()); // The MailChimp login URI the user needs to be sent to
<!-- Error contains custom Data when passed around to know the current status-->
oauth.on('error', function (error) {
    console.log(error.err);
});
 
oauth.on('authed', function (data) {
 
    try {
        var api = new MailChimpAPI(data.apiKey, { version : '1.3', secure : false });
    } catch (error) {
        console.log(error.message);
    }
 
    api.campaigns({ start: 0, limit: 25 }, function (error, data) {
        if (error)
            console.log(error.message);
        else
            console.log(JSON.stringify(data)); // Do something with your data!
    });
 
});

MailChimp 合作伙伴 API

MailChimpPartnerAPI有两个参数。第一个参数是您的应用程序密钥,如果您有资格使用合作伙伴 API,您可以在您的 MailChimp 帐户中生成和找到它。第二个参数是一个选项对象,它可以包含以下选项:

  • version要使用的合作伙伴 API 版本,目前只有 1.3 可用并受支持。默认为 1.3。
  • secure是否通过 HTTPS 使用安全连接 (true/false)。默认为假。
  • userAgent 要在请求标头中使用的自定义用户代理描述。

每个 API 方法的回调函数都有两个参数。第一个是一个错误对象,当没有发生错误时它为空,第二个是一个对象,只要没有发生错误就检索所有信息。

例子:

var MailChimpPartnerAPI = require('mailchimp').MailChimpPartnerAPI;
 
var appKey = 'Your MailChimp app key';
 
try {
    var api = new MailChimpPartnerAPI(appKey, { version : '1.3', secure : false });
} catch (error) {
    console.log(error.message);
}
 
api.checkUsername({ username: '/* USERNAME */' }, function (error, data) {
    if (error)
        console.log(error.message);
    else
        console.log(JSON.stringify(data)); // Do something with your data!
});

山钻API

MandrillAPI有两个参数。第一个参数是您的 API 密钥,您可以在您的 Mandrill 帐户中找到它。第二个参数是一个选项对象,它可以包含以下选项:

  • version要使用的 Mandrill API 版本,目前只有 1.0 可用和支持。默认为 1.0。
  • secure是否通过 HTTPS 使用安全连接 (true/false)。默认为假。
  • userAgent 要在请求标头中使用的自定义用户代理描述。

Mandrill API 文档 ( https://mandrillapp.com/api/docs/ ) 中描述的所有 API 类别和方法都可以在此包装器中找到。要使用该方法call,需要使用四个参数:

  • category 要调用的 API 方法的类别(例如“用户”)。
  • method 在给定类别中调用的方法。
  • params 传递给 API 方法的参数。
  • callback带有两个参数的返回数据或错误的回调函数。第一个是一个错误对象,当没有发生错误时它为空,第二个是一个对象,只要没有发生错误,就会检索所有信息。
var MandrillAPI = require('mailchimp').MandrillAPI;
 
var apiKey = 'Your Mandrill API Key';
 
try {
    var mandrill = new MandrillAPI(apiKey, { version : '1.0', secure: false });
} catch (error) {
    console.log(error.message);
}
 
mandrill.call('tags', 'time-series', { tag : '/* TAGNAME */'  }, function (error, data) {
    if (error)
        console.log(error.message);
    else
        console.log(JSON.stringify(data)); // Do something with your data!
});

MailChimp STS API

1.0.1 版起,MailChimpSTSAPI不再是此包装器的一部分,因为该 API 已被 MailChimp 停用。

执照

node-mailchimp在 MIT 许可下获得许可。(见许可证)

项目贡献人员列表:


极客公园 , 版权所有丨如未注明 , 均为原创丨本网站采用BY-NC-SA协议进行授权
转载请注明原文链接:mailchimp中文文档|mailchimp js中文教程|解析
喜欢 (0)
.excerpt .focus {display:none}