מדריך ה‑API של הודעות כלליות

הודעות כלליות הן באנרים קבועים שמוצגים בדף הסטטוס שלכם (בנפרד מתקריות ומתחזוקות). השתמשו בנקודות הקצה האלה כדי לנהל אותן באופן תוכניתי.

קבלת כל ההודעות הכלליות

נקודת קצה:

GET /v1/:page_id/generic-notices?page=:page&per_page=:per_page

• מספר העמוד שמוגדר כברירת מחדל הוא 1.
• ערך ברירת המחדל של per_page הוא 50, והמקסימום הוא 100 פריטים לעמוד.

דוגמת תשובה:

[
  {
    "id": "cl9mq0ah50646mpvlmbrvf979",
    "name": "Scheduled DNS migration",
    "message": "We are migrating our DNS provider over the next week.",
    "messageHtml": "<p>We are migrating our DNS provider over the next week.</p>",
    "notify": false,
    "isCollapsed": false,
    "createdAt": "2022-10-24T11:53:46.505Z",
    "updatedAt": "2022-10-24T11:53:46.505Z",
    "siteId": "cl9fzgilx14063qjvl5oqdtxtg",
    "importedFrom": null
  }
]

קבלת הודעה כללית

נקודת קצה:

GET /v1/:page_id/generic-notices/:generic_notice_id

דוגמת תשובה:

{
  "id": "cl9mq0ah50646mpvlmbrvf979",
  "name": "Scheduled DNS migration",
  "message": "We are migrating our DNS provider over the next week.",
  "messageHtml": "<p>We are migrating our DNS provider over the next week.</p>",
  "notify": false,
  "isCollapsed": false,
  "createdAt": "2022-10-24T11:53:46.505Z",
  "updatedAt": "2022-10-24T11:53:46.505Z",
  "siteId": "cl9fzgilx14063qjvl5oqdtxtg",
  "importedFrom": null
}

הוספת הודעה כללית

נקודת קצה:

POST /v1/:page_id/generic-notices

פרמטרים בגוף הבקשה:

• name (חובה) — כותרת ההודעה.
• message — גוף ההודעה. יש תמיכה ב‑HTML.
• notify — האם לעדכן את המנויים. ברירת המחדל היא false.
• isCollapsed — האם ההודעה מכווצת כברירת מחדל. ברירת המחדל היא false.
• translations — תרגומים אופציונליים עבור name ו‑message, לפי קוד שפה.

דוגמת בקשה:

{
  "name": "Scheduled DNS migration",
  "message": "We are migrating our DNS provider over the next week.",
  "notify": false,
  "isCollapsed": false,
  "translations": {
    "name": {
      "fr": "Migration DNS planifiée"
    },
    "message": {
      "fr": "Nous migrons notre fournisseur DNS au cours de la semaine prochaine."
    }
  }
}

דוגמת תשובה:

{
  "id": "cl9xobpoe00614tvldhh90t0w",
  "name": "Scheduled DNS migration",
  "message": "We are migrating our DNS provider over the next week.",
  "messageHtml": "<p>We are migrating our DNS provider over the next week.</p>",
  "notify": false,
  "isCollapsed": false,
  "createdAt": "2022-11-01T03:52:08.126Z",
  "updatedAt": "2022-11-01T03:52:08.126Z",
  "siteId": "cl9fzgilx14063qjvl5oqdtxtg",
  "importedFrom": null,
  "translations": {
    "name": {
      "fr": "Migration DNS planifiée"
    },
    "message": {
      "fr": "Nous migrons notre fournisseur DNS au cours de la semaine prochaine."
    }
  }
}

עדכון הודעה כללית

נקודת קצה:

PUT /v1/:page_id/generic-notices/:generic_notice_id

רק השדות שאתם שולחים מתעדכנים.

דוגמת בקשה:

{
  "name": "Scheduled DNS migration (rescheduled)",
  "message": "The migration has been rescheduled to next month.",
  "isCollapsed": true
}

דוגמת תשובה:

{
  "id": "cl9xobpoe00614tvldhh90t0w",
  "name": "Scheduled DNS migration (rescheduled)",
  "message": "The migration has been rescheduled to next month.",
  "messageHtml": "<p>The migration has been rescheduled to next month.</p>",
  "notify": false,
  "isCollapsed": true,
  "createdAt": "2022-11-01T03:52:08.126Z",
  "updatedAt": "2022-11-02T09:14:22.501Z",
  "siteId": "cl9fzgilx14063qjvl5oqdtxtg",
  "importedFrom": null
}

מחיקת הודעה כללית

נקודת קצה:

DELETE /v1/:page_id/generic-notices/:generic_notice_id

דוגמת תשובה:

{
  "id": "cl9xobpoe00614tvldhh90t0w",
  "name": "Scheduled DNS migration (rescheduled)",
  "message": "The migration has been rescheduled to next month.",
  "messageHtml": "<p>The migration has been rescheduled to next month.</p>",
  "notify": false,
  "isCollapsed": true,
  "createdAt": "2022-11-01T03:52:08.126Z",
  "updatedAt": "2022-11-02T09:14:22.501Z",
  "siteId": "cl9fzgilx14063qjvl5oqdtxtg",
  "importedFrom": null
}