Servicio de notificaciones

El servicio de notificación de la AFP permite que las plataformas de AFP Direct reciban notificaciones en la cuenta secundaria y sitio cambios de estado. Las plataformas pueden usar API de Platform para investigar los cambios.

Para recibir notificaciones, implementa un servidor que acepte POST solicita y analiza la carga útil de JSON descrita en el esquema (consulta ejemplo de configuración). Luego, debes proporcionar la URL del extremo a tu administrador de socios estratégicos para activar el servicio.

Esquema

La carga útil de notificaciones debe cumplir con el siguiente esquema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Notification",
  "type": "object",
  "properties": {
    "accountName": {
      "type": "string",
      "description": "The name of the modified sub-account."
    },
    "domain": {
      "type": "string",
      "description": "The domain the notification refers to, if any. Optional (only populated for SITE_APPROVAL)"
    },
    "notificationType": {
      "type": "string",
      "enum": ["PUBLISHER_APPROVAL", "SITE_APPROVAL"],
      "description": "Type of notification"
    }
  },
  "required": ["platformPublisherId", "publisherId", "notificationType"],
  "additionalProperties": false
}

Se podrían agregar más campos notificationTypes y otros más adelante.

Ejemplos

Una notificación de aprobación del publicador se vería de la siguiente manera:

{
  "accountName" : "platforms/pub-1234567890123456/accounts/pub-0987654321654321",
  "notificationType": "PUBLISHER_APPROVAL"
}

Una notificación de aprobación del sitio se vería de la siguiente manera:

{
  "accountName" : "platforms/pub-1234567890123456/accounts/pub-0987654321654321",
  "domain": "afpsite.com",
  "notificationType": "SITE_APPROVAL"
}

Configuración de ejemplo

El siguiente es un ejemplo de un servidor Node.js que registra el contenido de una notificación:

// Import express
const express = require('express');

// Create an express application
const app = express();

// Middleware to parse JSON bodies
app.use(express.json());

// Define a route to receive POST requests
app.post('/notification', (req, res) => {
    console.log('Received account name:', req.body.accountName)
    console.log('Received Domain:', req.body.domain)
    console.log('Received notification type', req.body.notificationType)

    // Send a response back to the client
    res.status(200).send('Notification received');
});

// Start the server
const PORT = process.env.PORT || 8080;
app.listen(PORT, () => {
  console.log(`Server running on port ${PORT}`);
});

Ejemplo de URL de extremo: https://yourdomain.com/your-endpoint

Verifica que el extremo funcione. Para ello, envía una solicitud POST con curl:

curl -X POST https://yourdomain.com/your-endpoint \
     -H "Content-Type: application/json" \
     -d '{"accountName": "platforms/pub-1234567890123456/accounts/pub-0987654321654321", \
        "notificationType": "PUBLISHER_APPROVAL"}'

Configura robots.txt

Asegúrate de que el servicio de notificaciones tenga acceso a tu extremo. El de notificaciones respeta las directivas que se describen en el archivo robots.txt de la raíz de tu dominio, si existe uno:

User-agent: GoogleOther
Disallow: <ensure your endpoint is not disallowed>