התאם אישית את המיתוג והעיצובים של מרכז העזרה בעזרת ממשק ה-API Notiondesk

ממשק ה-API Notiondesk מאפשר לך לקרוא ולשנות את המיתוג של מרכז העזרה שלך: צבעים, גופנים, פריסה, כותרת עליונה ותחתונה, קישורים, תצוגת חיפוש ומשוב וערכת נושא. השתמש בו כדי לפרוס את אותו מותג במספר מרכזי עזרה, או כדי לשמור את המיתוג שלך בקוד לצד שאר מערכת העיצוב שלך.

מיתוג גלוי בכל דף ציבורי, לכן עדכונו דורש את ההיקף admin, ולא write. רק מפתח שנוצר על ידי בעל סביבת עבודה או מנהל מחזיק ב-admin.

כדי לשנות את המיתוג בלוח המחוונים במקום זאת, ראה התאמה אישית של צבעי וגופנים של מרכז העזרה .

מה שה-API לא משנה

אלה נשארים בלוח המחוונים בלבד. נתיב הקריאה אינו מחזיר אותם, ועדכון ששמו עונה על 400 validation_error:

• CSS מותאם אישית ו-JavaScript מותאם אישית. ראה התאמה אישית של מרכז העזרה שלך באמצעות CSS מותאם אישית ;

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

קראו את המיתוג שלכם

התגובה מכילה בדיוק את השדות שהעדכון מקבל, תחת אותם שמות. דוגמה מקוצרת:

curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/settings/customize" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

{
  "colors": {
    "primary": "#2563eb",
    "text": "#111827",
    "link": "#2563eb",
    "link_hover": "#1d4ed8",
    "header": "#2563eb",
    "header_text": "#ffffff",
    "background": "#ffffff",
    "footer_background": ""
  },
  "appearance": null,
  "layout_collection": "column_2",
  "layout_article": "column_1",
  "footer_layout": "compact",
  "primary_font": "Inter",
  "header_links": [{"title": "Docs", "url": "https://example.com/docs"}],
  "footer_links": [{"title": "Product", "links": [{"title": "Pricing", "url": "https://example.com/pricing"}]}],
  "show_powered_by_badge": false,
  "theme": null
}

• צבע שמעולם לא הוגדר הוא "". colors.dark מכיל את צבעי המצב הכהה, ונעדר כאשר למרכז העזרה אין פלטת צבעים כהה.

• רשימה שאינה מכילה דבר קוראת [].

• theme הוא ה-code של ערכת הנושא הנוכחית, או null.

עדכנו את המיתוג שלכם

המסלול עונה על 204 No Content. קרא שוב את המיתוג כדי לאשר את השינוי.

curl -i -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/settings/customize" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16" \
  -H "Content-Type: application/json" \
  -d '{"primary_font": "Inter", "colors": {"primary": "#2563eb"}, "header_links": [{"title": "Docs", "url": "https://example.com/docs"}]}'

• שדה שאתה משמיט שומר על ערכו. בתוך colors, גם צבע שאתה משמיט שומר על ערכו.

• רשימה שאתה שולח מחליפה את כל הרשימה המאוחסנת, ו-[] מרוקן אותה.

• צבעים הם ערכים הקסדצימליים #rrggbb, או "". צורות קצרות כגון #fff נדחות.

• שלח ערכים בוליאניים של JSON. הערכים 0 ו-"false" נקראים כ-true, ו-null כ-false.

כל עדכון שמתקבל מרענן את כל מרכז העזרה: Notiondesk מנקה את הדפים המאוחסנים במטמון ובונה מחדש כל עמוד, ללא קשר לשינוי העדכון. שלח כל שינוי בבקשה אחת, לא בקשה אחת לכל שדה.

עדכונים בטוחים: קריאה, שינוי, החזרה

הדרך הבטוחה ביותר לעדכן את המיתוג היא לשלוח בחזרה את מה שקראתם, לאחר שהשינויים שלכם יוחלו. שדה שנשלח עם ערכו הנוכחי מתקבל בכל תוכנית, כך שתבנית זו לעולם לא מגבילה את מגבלת התוכנית בשדות שלא נגעתם ​​בהם.

ניתן לסרב לגוף שנשלח בחזרה בשני מקרים. יש לתקן את הערך בלוח המחוונים, או להשאיר שדה זה מחוץ לגוף:

const url = "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/settings/customize";
const headers = {
  Authorization: `Bearer ${process.env.NOTIONDESK_API_KEY}`,
  "nd-version": "2026-10-16",
  "Content-Type": "application/json",
};

const branding = await (await fetch(url, { headers })).json();
branding.colors.primary = "#7c3aed";
branding.colors.link = "#7c3aed";

const response = await fetch(url, { method: "PATCH", headers, body: JSON.stringify(branding) });
console.log(response.status);

• צבע מאוחסן בצורה מקוצרת כגון #fff;

• רשימה מאוחסנת ארוכה מהמגבלות שלהלן.

שדות שניתן לשנות

קישורים הם אובייקטים עם title ו-url. קבוצות קישורים בתחתית העמודה הן אובייקטים עם title ורשימה links. תרגומים הם אובייקטים עם locale ואת ה-links, groups או value המתורגמים.

מגבלות התוכנית

שינוי אחד מהם בתוכנית ללא התכונה עונה על 403 permission_denied, ההודעה נותנת שם לתכונה, ושום דבר לא כתוב.

ללא התאמה אישית מתקדמת, צבעי הכותרת התחתונה שומרים על הערך המאוחסן שלהם ללא שגיאה. ללא צ'אטבוט בינה מלאכותית מופעל, גם ai_search_display_mode, ai_search_aside_position ו-ai_search_enabled: true שומרים על הערך המאוחסן שלהם.

מגבלות רשימה

• כל רשימה מכילה עד 100 רשומות, וכך גם כל רשימה links או groups בתוכה.

• כל הרשימות יחד מכילות עד 3,000 ערכים, כולל ערכים מקוננים והרשימות המאוחסנות שהגוף שלך משמיט.

כפתור יצירת הקשר מפעיל את טופס יצירת הקשר

בעוד ש-show_contact_us_button נמצא ב-true בתוכנית עם התאמה אישית מתקדמת, כל עדכון מיתוג מפעיל את טופס יצירת הקשר של מרכז העזרה, כפי שעושה שמירה בלוח המחוונים. עיין בסעיף טופס יצירת הקשר בעדכון הגדרות מרכז העזרה באמצעות ממשק ה-API של Notiondesk .

בחר נושא

הרשימה תמיד מכילה כל נושא בתגובה אחת, בסדר תצוגה. יש להחיל אחד על ידי שליחת ה-code שלה כ-theme:

הגדרת ערכת נושא דורשת התאמה אישית מתקדמת. שליחת "theme": null משאירה את ערכת הנושא ללא שינוי.

שגיאות

curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/themes" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

{
  "object": "list",
  "data": [
    {
      "code": "ocean",
      "name": "Ocean",
      "description": "A calm, airy theme",
      "preview_image_url": "https://example.com/ocean.png",
      "layout": "default"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

curl -i -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/settings/customize" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16" \
  -H "Content-Type: application/json" \
  -d '{"theme": "ocean"}'

שגיאות שדה מציינות את הערך, לדוגמה colors.primary או footer_links[0].links. ראה טיפול בשגיאות Notiondesk API, מגבלות קצב וניסיונות חוזרים .

שאלות נפוצות

מה הלאה

• עדכון הגדרות מרכז העזרה באמצעות ממשק ה-API Notiondesk

• ניהול אינטגרציות במרכז העזרה עם ממשק ה-API Notiondesk

• אוטומציה של משימות נפוצות במרכז העזרה בעזרת ממשק ה-API Notiondesk