Usługa powiadomień
Usługa powiadomień AFP umożliwia platformom AFP Direct otrzymywanie powiadomień o zmianach stanu subkonta i witryny. Platformy mogą używać interfejsu Platform API do sprawdzania zmian.
Aby otrzymywać powiadomienia, wdrożyć serwer, który akceptuje żądania POST i analizuje ładunek JSON określony w schemacie (patrz przykładowa konfiguracja). Następnie musisz podać URL punktu końcowego swojemu menedżerowi ds. partnera strategicznego, aby aktywować usługę.
Schemat
Ładunek powiadomienia musi być zgodny z tym schematem:
{
"$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
}
W przyszłości możemy dodać więcej pól notificationTypes
i innych pól.
Przykłady
Powiadomienie o zatwierdzeniu wydawcy będzie wyglądać tak:
{
"accountName" : "platforms/pub-1234567890123456/accounts/pub-0987654321654321",
"notificationType": "PUBLISHER_APPROVAL"
}
Powiadomienie o zatwierdzeniu witryny będzie wyglądać tak:
{
"accountName" : "platforms/pub-1234567890123456/accounts/pub-0987654321654321",
"domain": "afpsite.com",
"notificationType": "SITE_APPROVAL"
}
Przykładowa konfiguracja
Poniżej znajdziesz przykład serwera NodeJS, który rejestruje zawartość powiadomienia:
// 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}`);
});
Przykładowy adres URL punktu końcowego: https://yourdomain.com/your-endpoint
Aby sprawdzić, czy punkt końcowy działa, wyślij żądanie POST za pomocą 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"}'
Konfigurowanie pliku robots.txt
Upewnij się, że usługa powiadomień ma dostęp do punktu końcowego. Usługa powiadomień przestrzega dyrektyw opisanych w pliku robots.txt
w katalogu głównym Twojej domeny (jeśli istnieje):
User-agent: GoogleOther
Disallow: <ensure your endpoint is not disallowed>