שירות התראות

שירות ההתראות של AFP מאפשר לפלטפורמות של AFP Direct לקבל התראות על שינויים בסטטוס של חשבון המשנה ושל האתר. פלטפורמות יכולות להשתמש ב-Platform API כדי לבדוק שינויים.

כדי לקבל התראות, צריך להטמיע שרת שמקבל בקשות POST ומנתח את עומס העבודה של ה-JSON שמתואר בסכימה (ראו הגדרה לדוגמה). לאחר מכן, צריך לספק את כתובת ה-URL של נקודת הקצה למנהל של שותף האסטרטגי כדי להפעיל את השירות.

סכימה

המטען הייעודי של ההתראה חייב לעמוד בהסכימה הבאה:

{
  "$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
}

אפשר להוסיף עוד notificationTypes ושדות אחרים מאוחר יותר.

דוגמאות

הודעה על אישור של בעל תוכן דיגיטלי תיראה כך:

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

התראה על אישור אתר תיראה כך:

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

דוגמה להגדרה

דוגמה לשרת NodeJS שמתעדה ביומן את התוכן של התראה:

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

דוגמה לכתובת URL של נקודת קצה: https://yourdomain.com/your-endpoint

כדי לוודא שנקודת הקצה פועלת, שולחים בקשת POST באמצעות 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"}'

הגדרת קובץ robots.txt

מוודאים שלשירות ההתראות יש גישה לנקודת הקצה. שירות ההתראות פועל בהתאם להנחיות שמפורטות בקובץ robots.txt ברמה הבסיסית (root) של הדומיין, אם קיים כזה:

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