使用 NodeJS 集成 OneSignal API
我们通常使用 OneSignal API 来传递通知、电子邮件、导出数据、创建和删除段等。我们将使用onesignal-node模块将 OneSignal API 集成到 NodeJS 中。 onesignal-node是 OneSignal API 的 Node.js 客户端库,将有助于我们这样做。
整合步骤
第 1 步:确保您的计算机或项目中安装了 NodeJs。如果您需要安装它,您可以从这里进行。
第 2 步:打开终端并在您的项目中初始化 npm。
npm init
安装后,终端会询问项目的详细信息。根据您的需要更新它们。
注意:完成后按回车键,将显示以下提示。
第 3 步:使用以下命令安装onesignal-node 模块。
npm install onesignal-node --save
第 4 步:使用以下代码开始使用onesignal-node以要求模块。
const OneSignal = require('onesignal-node');
第 5 步:使用客户端操作将您的应用程序集成到OneSignal。
我们将OneSignal.Client用于创建通知、添加设备、CSV 导出、创建分段等操作。为此,我们需要首先获取我们的appId和apikey 。为此,请执行以下步骤:
- 打开您的 OneSignal 帐户并转到设置。
- 打开密钥和 ID 选项卡。
- 您可以在此处访问您的 OneSignal 应用 ID 和 apikey。
在此之后,使用OneSignal.Client方法中的 Id 和密钥,如下所示:
script.js
// With default options
const client = new OneSignal.Client('appId', 'apiKey');
// With custom API endpoint
const client = new OneSignal.Client('appId', 'apiKey',
{ apiRoot: 'https://onesignal.com/api/v2'});
script.js
// With default options
const userClient = new OneSignal.UserClient('userAuthKey');
// With custom API endpoint
const userClient = new OneSignal.UserClient('userAuthKey',
{ apiRoot: 'https://onesignal.com/api/v2'});
对于查看应用程序、更新应用程序、创建应用程序等操作。等等,我们使用OneSignal.UserClient。为此,我们需要获取 User Auth 密钥:
可以在帐户中找到的用户身份验证密钥管理应用程序外的操作。单击仪表板右上角的“帐户”下拉列表,然后向下滚动到“用户身份验证密钥”部分。它超出了显示每个应用程序的身份验证密钥的部分。
在 OneSignal.UserClient 方法中使用它,如下所示:
脚本.js
// With default options
const userClient = new OneSignal.UserClient('userAuthKey');
// With custom API endpoint
const userClient = new OneSignal.UserClient('userAuthKey',
{ apiRoot: 'https://onesignal.com/api/v2'});
现在,OneSignal API 与 NodeJs 集成,您可以使用它来创建、取消和查看通知、创建、查看和更新应用程序、查看、添加和编辑设备、创建和删除段等。
参考:
- https://www.npmjs.com/package/onesignal-node
- https://documentation.onesignal.com/docs/accounts-and-keys