Serviço de notificação

O serviço de notificação do AFP permite que plataformas transparentes do AFP recebam notificações após aprovações de PlatformChildSite, indicando que o site agora está disponível na API.

Para receber notificações, implemente um servidor que aceite solicitações POST e analise o payload JSON descrito no esquema (consulte o exemplo de configuração). Em seguida, forneça o URL do endpoint ao gerente de parceiro estratégico para ativar o serviço.

Esquema

O payload da notificação precisa seguir o seguinte esquema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Notification",
  "type": "object",
  "properties": {
    "platformPublisherId": {
      "type": "string",
      "description": "The unique identifier for the platform publisher."
    },
    "publisherId": {
      "type": "string",
      "description": "The unique identifier for the publisher."
    },
    "platformChildSiteName": {
      "type": "string",
      "description": "The name of the PlatformChildSite the notification refers to (populated for SITE_APPROVAL)."
    },
    "notificationType": {
      "type": "string",
      "enum": ["SITE_APPROVAL"],
      "description": "Type of notification"
    },
  },
  "required": ["platformPublisherId", "publisherId", "notificationType"],
  "additionalProperties": false
}

Mais notificationTypes e outros campos podem ser adicionados mais tarde.

Exemplos

Uma notificação SITE_APPROVAL vai ficar assim:

{
  "platformPublisherId" : "pub-123",
  "publisherId" : "pub-456",
  "platformChildSiteName" : "accounts/pub-123/platforms/my-platform/childAccounts/pub-456/sites/child-domain.com",
  "notificationType": "SITE_APPROVAL"
}

Exemplo de configuração

Confira a seguir um exemplo de um servidor NodeJS que registra o conteúdo de uma notificação:

// 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 platformPublisherId:', req.body.platformPublisherId)
    console.log('Received publisherId:', req.body.publisherId)
    console.log('Received platformChildSiteName:', req.body.platformChildSiteName)
    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}`);
});

Exemplo de URL do endpoint: https://yourdomain.com/your-endpoint

Para verificar se o endpoint está funcionando, envie uma solicitação POST usando curl:

curl -X POST https://yourdomain.com/your-endpoint \
     -H "Content-Type: application/json" \
     -d '{"platformPublisherId" : "pub-123", \
          "publisherId" : "pub-456", \
          "platformChildSiteName" : "accounts/pub-123/platforms/my-platform/childAccounts/pub-456/sites/child-domain.com", \
          "notificationType": "SITE_APPROVAL"}'

Configurar o robots.txt

Verifique se o serviço de notificação tem permissão de acesso ao endpoint. O serviço de notificação respeita as diretivas descritas no arquivo robots.txt da raiz do seu domínio, se houver um:

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