Serviço de notificação
O serviço de notificação AFP permite que as plataformas do AFP Direct recebam notificações sobre mudanças no estado da subconta e do site. As plataformas podem usar a API Platform para investigar mudanças.
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 seu Gerente de Parceiros Estratégicos para ativar o serviço.
Esquema
O payload da notificação precisa aderir ao seguinte 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
}
Mais campos notificationTypes
e outros podem ser adicionados depois.
Exemplos
Uma notificação de aprovação do editor tem esta aparência:
{
"accountName" : "platforms/pub-1234567890123456/accounts/pub-0987654321654321",
"notificationType": "PUBLISHER_APPROVAL"
}
Uma notificação de aprovação do site tem esta aparência:
{
"accountName" : "platforms/pub-1234567890123456/accounts/pub-0987654321654321",
"domain": "afpsite.com",
"notificationType": "SITE_APPROVAL"
}
Exemplo de configuração
Veja a seguir um exemplo de 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 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}`);
});
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 '{"accountName": "platforms/pub-1234567890123456/accounts/pub-0987654321654321", \
"notificationType": "PUBLISHER_APPROVAL"}'
Configurar o robots.txt
Verifique se o serviço de notificação tem permissão para acessar seu endpoint. O serviço de notificação respeita as diretivas descritas no arquivo robots.txt
da raiz do seu domínio, se houver:
User-agent: GoogleOther
Disallow: <ensure your endpoint is not disallowed>