ממשק ה-API Notiondesk מאפשר לך לשנות את הגדרות מרכז העזרה שלך מהקוד: אינדוקס מנועי חיפוש, כותרת ותיאור הדף בכל שפה, אופטימיזציה של בינה מלאכותית, טופס יצירת הקשר ויומן השינויים. השתמש בו כדי להחיל את אותה תצורה על מספר מרכזי עזרה, או כדי לשמור על הגדרות תחת בקרת גרסאות.
| שִׁיטָה | נָתִיב | תְחוּם | שינויים |
|---|---|---|---|
PATCH | /sites/{site_id}/settings/content | write | אינדוקס מנועי חיפוש, כותרת ותיאור עמוד לפי שפה |
PATCH | /sites/{site_id}/settings/ai-optimization | write | llms.txt, ייצוא markdown ותפריט ההקשר של בינה מלאכותית |
PATCH | /sites/{site_id}/settings/contact-form | write | האם טופס יצירת הקשר מוצג |
PATCH | /sites/{site_id}/settings/changelog | write | יומן השינויים והאפשרויות שלו |
לשפות ולתרגום אוטומטי יש מאמר משלהם: ניהול שפות ותרגום אוטומטי באמצעות ממשק ה-API Notiondesk . צבעים, גופנים ופריסה נמצאים בהתאמה אישית של מיתוג וערכות נושא במרכז העזרה באמצעות ממשק ה-API Notiondesk .
כיצד פועלים עדכוני הגדרות
כל מסלול בדף זה פועל לפי אותם כללים:
- שלח רק את מה שאתה משנה. שדה שאתה משמיט שומר על ערכו הנוכחי.
- התשובה היא
204 No Content, ללא גוף, גם כאשר דבר לא השתנה. קרא את המצב החדש עםGET /sites/{site_id}, כמתואר בקרא את מרכזי העזרה שלך עם ממשק ה-API Notiondesk .
- שלח ערכים בוליאניים של JSON.
trueאוfalseבלבד: הערכים0ו-"false"נקראים כ-true.
- שדות לא ידועים נדחים עם 400
validation_error, ושום דבר לא משתנה.
- ניסיונות חוזרים בטוחים עם
Idempotency-Key. ראה טיפול בשגיאות API, מגבלות קצב וניסיונות חוזרים של Notiondesk .
אינדוקס מנועי חיפוש, כותרות ותיאורי דפים
curl -i -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/settings/content" \
-H "Authorization: Bearer $NOTIONDESK_API_KEY" \
-H "nd-version: 2026-10-16" \
-H "Content-Type: application/json" \
-d '{"seo_indexing_enabled": true, "items": [{"locale": "fr", "page_title": "Centre d aide Example", "page_description": "Toutes les réponses sur Example"}]}'| שָׂדֶה | סוּג | הערות | קרא בחזרה כ |
|---|---|---|---|
seo_indexing_enabled | בוליאני | האם מנועי חיפוש רשאים לאנדקס את מרכז העזרה | seo_indexing_enabled |
items | רשימת חפצים | אובייקט אחד לכל שפה לשינוי | setting_content_items |
כל אובייקט ב-items:
| שָׂדֶה | סוּג | הערות |
|---|---|---|
locale | חוּט | נדרש. שפה שמרכז העזרה משרת, לכל היותר פעם אחת ברשימה |
page_title | מחרוזת או ריק | עד 255 תווים. null מנקה אותו |
page_description | מחרוזת או ריק | עד 255 תווים. null מנקה אותו |
אובייקט משנה רק את השדות שהוא נושא, ושפה שאתה משמיט מ-items שומרת על הכותרת והתיאור שלה. items לא יכול להוסיף או להסיר שפה.
שגיאה בשפה אחת נותנת לו שם בנתיב השדה, לדוגמה items[fr].page_title.
seo_indexing_enabled: false מבקש ממנועי חיפוש להפסיק את אנדוקס מרכז העזרה שלך כולו. ראה מניעת סריקה ואנדוקס של מרכז העזרה שלך על ידי מנועי חיפוש .אופטימיזציה של בינה מלאכותית
curl -i -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/settings/ai-optimization" \
-H "Authorization: Bearer $NOTIONDESK_API_KEY" \
-H "nd-version: 2026-10-16" \
-H "Content-Type: application/json" \
-d '{"llms_txt_enabled": true, "markdown_export_enabled": true, "ai_contextual_menu_enabled": true}'| שָׂדֶה | סוּג | קרא בחזרה כ |
|---|---|---|
llms_txt_enabled | בוליאני: האם מרכז העזרה מפרסם llms.txt | llms_txt_enabled |
markdown_export_enabled | בוליאני: האם ניתן לקרוא מאמרים כ-markdown | markdown_export_enabled |
ai_contextual_menu_enabled | בוליאני: האם מאמרים מציגים את תפריט ההקשר של בינה מלאכותית | ai_contextual_menu_enabled |
התוכנית שלך חייבת לכלול אופטימיזציה של בינה מלאכותית. למד מה כל תכונה עושה בהגדרת אופטימיזציה של בינה מלאכותית במרכז העזרה שלך ובמבוא לאופטימיזציה של גיאוגרפיה/בינה מלאכותית .
טופס יצירת קשר
curl -i -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/settings/contact-form" \
-H "Authorization: Bearer $NOTIONDESK_API_KEY" \
-H "nd-version: 2026-10-16" \
-H "Content-Type: application/json" \
-d '{"enabled": false}'| שָׂדֶה | סוּג | קרא בחזרה כ |
|---|---|---|
enabled | בוליאני: האם מרכז העזרה מציג את טופס יצירת הקשר שלו | contact_form_enabled |
- ה-API מפעיל או מכבה את הטופס, לא יותר. הכתובות שמקבלות הגשות מוגדרות בלוח המחוונים. גוף עם
destination_emailsעונה על 400validation_errorולא משנה דבר.
- הטופס נשאר פעיל רק עם כתובת מאוחסנת. הפעלתו עבור מרכז עזרה ללא כתובת עונה על 400
validation_errorעבורdestination_emails. הגדר תחילה כתובת בלוח המחוונים. כיבוי הטופס אינו דורש כתובת.
- התוכנית שלך חייבת לכלול התאמה אישית מתקדמת, אפילו כדי לכבות את הטופס.
יומן שינויים
curl -i -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/settings/changelog" \
-H "Authorization: Bearer $NOTIONDESK_API_KEY" \
-H "nd-version: 2026-10-16" \
-H "Content-Type: application/json" \
-d '{"enabled": true, "reactions_enabled": true, "changelog_categories": [{"category_id": "2984612035", "color": "blue_sky"}]}'| שָׂדֶה | סוּג | הערות | קרא בחזרה כ |
|---|---|---|---|
enabled | בוליאני | האם יומן השינויים מתפרסם | changelog_enabled |
email_subscriptions_enabled | בוליאני | האם קוראים יכולים להירשם להודעות דוא"ל של יומן שינויים. true זקוק לתוכנית עם התראות דוא"ל של יומן שינויים | changelog_email_subscriptions_enabled |
reactions_enabled | בוליאני | האם קוראים יכולים להגיב לרשומות ביומן השינויים | changelog_reactions_enabled |
email_subject_pattern | חוּט | שורת הנושא של הודעות דוא"ל עם יומן שינויים, עד 255 תווים. לא ניתן לנקות אותה: null ו-"" משאירים אותה ללא שינוי. | changelog_email_subject_pattern |
changelog_categories | רשימת חפצים | הסט המלא של אוספי יומן השינויים | changelog_categories |
לכל אובייקט ב-changelog_categories יש category_id נדרש, id של אחד מהאוספים שלך, ו-color אופציונלי של עד 255 תווים.
changelog_categories מחליף את כל הקבוצה. אוסף שאתה משמיט מפסיק להיות אוסף שינויים, ומסיר את כולם. קרא מההתחלה כאשר אתה רוצה להוסיף רק אחד. הקבוצה מכילה עד 100 אוספים.[]changelog_categoriesGET /sites/{site_id}התוכנית שלך חייבת לכלול את יומן השינויים. אם מנויי דוא"ל מופעלים אך התוכנית שלך אינה כוללת עוד התראות דוא"ל מיומן שינויים, כל בקשה לנתיב זה עונה על 403 permission_denied עד שהיא שולחת "email_subscriptions_enabled": false.
למידע נוסף, ראה הגדרת יומני שינויים במרכז העזרה שלך ו- כיצד להפעיל מנויי דוא"ל עבור יומני השינויים שלך .
שגיאות
| סטָטוּס | כַּאֲשֵׁר | code |
|---|---|---|
| 400 | ערך אינו חוקי או ארוך מדי, שפה או אוסף אינם ידועים או חוזרים על עצמם, יותר מ-100 אוספי שינויים, destination_emails נשלח, טופס יצירת הקשר נשאר ללא כתובת, או שהגוף מכיל שדה לא ידוע. | validation_error |
| 403 | למפתח חסר ההיקף write | insufficient_scope |
| 403 | התוכנית שלך אינה כוללת את התכונה (אופטימיזציה של בינה מלאכותית, התאמה אישית מתקדמת, יומן שינויים או התראות דוא"ל של יומן שינויים), או שיוצר המפתח אינו יכול לשנות את מרכז העזרה הזה. | permission_denied |
| 404 | מרכז העזרה אינו קיים בסביבת העבודה שלך | not_found |
ראה טיפול בשגיאות Notiondesk של ה-API, מגבלות קצב וניסיונות חוזרים עבור מעטפת השגיאה והקודים האחרים.
שאלות נפוצות
איך אני מאשר/ת שינוי בהגדרות?
קרא GET /sites/{site_id}. כל עמודה "קרא חזרה כ" של השדה שמעליה מציינת את המקום שבו מופיע הערך החדש.
האם ניתן לשנות את כתובות הדוא"ל של טופס יצירת הקשר באמצעות ה-API?
לא. הגדר אותם בלוח המחוונים. ה-API רק מפעיל או מכבה את הטופס.
האם ניתן להפעיל את חיפוש MCP באמצעות ה-API?
לא. הפעל את חיפוש MCP בלוח המחוונים. ה-API מציג את מצבו ב-mcp_search_enabled. ראה הפעלת חיפוש MCP .
האם ניתן לשנות את מצב הגישה של מרכז העזרה באמצעות ה-API?
לא. גישה ציבורית, גישה לסיסמה וגישה לחשבון אורח מוגדרות בלוח המחוונים. ה-API מציג את המצב הנוכחי ב-access_mode.