Integración de la API de OneSignal mediante Node.js

Por lo general, usamos la API de OneSignal para enviar notificaciones, enviar correos electrónicos, exportar datos, crear y eliminar segmentos, etc. Usaremos el módulo onesignal-node para integrar la API de OneSignal en NodeJS. onesignal -node es una biblioteca de cliente de Node.js para la API de OneSignal y será útil para permitirnos hacerlo.

Pasos para integrar

• Paso 1: asegúrese de que NodeJs esté instalado en su computadora o en su proyecto. En caso de que necesites instalarlo, puedes hacerlo desde aquí .

• Paso 2: Abra la terminal e inicialice npm en su proyecto.

  npm init

  Después de la instalación, la terminal solicita detalles del proyecto. Actualízalos de acuerdo a tu necesidad.

  Nota: Presione enter cuando haya terminado, se mostrará el siguiente mensaje.

• Paso 3: instale un módulo de Node de señal con el siguiente comando.

  npm install onesignal-node --save

• Paso 4: Comience a usar onesignal-node usando el siguiente código para solicitar el módulo.

  const OneSignal = require('onesignal-node');

• Paso 5: integre su aplicación a OneSignal usando acciones del cliente.

Usamos OneSignal.Client para acciones como crear una notificación, agregar un dispositivo, exportar CSV, crear un segmento, etc. Para esto, primero debemos obtener nuestro appId y apikey . Para ello, sigue los siguientes pasos:

1. Abra su cuenta OneSignal y vaya a la configuración.
2. Abra la pestaña Claves e ID.
3. Puede acceder a su ID de aplicación OneSignal y apikey aquí.

Después de esto, use la identificación y la clave en su método OneSignal.Client como se muestra a continuación:

// 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'});

Para acciones como ver aplicaciones, actualizar una aplicación, crear una aplicación. etc., usamos OneSignal.UserClient. Para esto, necesitamos adquirir la clave de autenticación de usuario:

La clave de autenticación de usuario que se puede encontrar en la cuenta administra las operaciones fuera de una aplicación. Haga clic en el menú desplegable Cuenta en la parte superior derecha de su tablero y desplácese hacia abajo hasta la sección Clave de autenticación de usuario. Está más allá de la sección que muestra cada una de las claves de autenticación de su aplicación.

Use esto en el método OneSignal.UserClient como se muestra a continuación:

// 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'});

Ahora, la API de OneSignal está integrada con NodeJs, puede usarla para crear, cancelar y ver notificaciones, crear, ver y actualizar aplicaciones, ver, agregar y editar dispositivos, crear y eliminar segmentos, etc.

Referencia:

• https://www.npmjs.com/package/onesignal-Node
• https://documentation.onesignal.com/docs/accounts-and-keys