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

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

שִׁיטָה	נָתִיב	תְחוּם	האם
`GET`	`/sites/{site_id}/integrations`	`read`	מפרט את הספקים שהוגדרו
`PATCH`	`/sites/{site_id}/integrations/{type}`	`admin`	מגדיר ספק ומפעיל אותו
`POST`	`/sites/{site_id}/integrations/{type}/disable`	`admin`	מכבה ספק

הגדרה וכיבוי של ספקים דורשים תוכנית הכוללת אינטגרציות.

כל ספק טוען סקריפט של צד שלישי בכל עמוד במרכז העזרה שלך. מכולה של Google Tag Manager מריץ כל מה שבעליו מפרסם, ו-Plausible או Umami מחליטים מאיפה נטען סקריפט האנליטיקה. לכן שינוי אינטגרציות דורש היקף. תן מפתח רק לאינטגרציות שאתה סומך עליהן.proxy_urladminadmin

ספקים נתמכים

`type`	שָׂדֶה	דָרוּשׁ	פוּרמָט	מדריך התקנה
`google-analytics`	`tracking_id`	כֵּן	מזהה מדידה של Google Analytics 4: `G-` ו-10 אותיות גדולות או ספרות, כגון `G-ABCDEFGHIJ`	גוגל אנליטיקס
`plausible-analytics`	`domain`	כֵּן	דומיין האתר שלך כפי שהוא רשום ב-Plausible	אנליטיקה סבירה
`plausible-analytics`	`proxy_url`	לֹא	מקור `https` שממנו אתה מבצע פרוקסי לסקריפט, כגון `https://plausible.example.com`
`umami`	`website_id`	כֵּן	אותיות, ספרות, `-` ו-`_`	אומאמי
`umami`	`proxy_url`	לֹא	מקור `https` שממנו אתה מבצע פרוקסי לסקריפט, כגון `https://umami.example.com`
`intercom`	`app_id`	כֵּן	אותיות, ספרות, `-` ו-`_`	אינטרקום
`crisp`	`app_id`	כֵּן	אותיות, ספרות, `-` ו-`_`	פָּרִיך
`helpscout`	`beacon_id`	כֵּן	אותיות, ספרות, `-` ו-`_`	עזרה בצופים
`google-tag-manager`	`container_id`	כֵּן	אותיות, ספרות, `-` ו-`_`, כגון `GTM-ABC123`	מנהל התגים של גוגל

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

רשום את האינטגרציות שלך

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

{
  "object": "list",
  "data": [
    {
      "type": "plausible-analytics",
      "settings": {"domain": "help.example.com", "proxy_url": null},
      "enabled": true
    },
    {
      "type": "crisp",
      "settings": {"app_id": "7d1c9a2e-5b4f-4e3a-9c8d-2f1e0a9b8c7d"},
      "enabled": false
    }
  ],
  "has_more": false,
  "next_cursor": null
}

שָׂדֶה	מַשְׁמָעוּת
`type`	הספק
`settings`	שדות הספק. `null` כאשר הספק הופעל בלוח המחוונים מבלי שתצורתו הוגדרה.
`enabled`	האם מרכז העזרה טוען את הספק

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

הגדרת ספק

שלח את השדות של הספק לנתיב שלו. הנתיב עונה על 200 OK עם האינטגרציה.

curl -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/integrations/plausible-analytics" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16" \
  -H "Content-Type: application/json" \
  -d '{"domain": "help.example.com"}'

{
  "type": "plausible-analytics",
  "settings": {"domain": "help.example.com", "proxy_url": null},
  "enabled": true
}

עדכון תמיד מפעיל את הספק. אין שדה enabled: כדי לכבות ספק, השתמש בנתיב השבתה.

שדה שאתה משמיט שומר על הערך המאוחסן שלו. כדי להפעיל מחדש ספק שתצורתו נקבעה מבלי לשנות אותו, שלח {}.

כדי להסיר פרוקסי, שלח "proxy_url": null.

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

הערה: ערך שנשמר לפני שהפורמטים הנוכחיים הוחלו, כגון מזהה Google Analytics או מזהה שאינו , ייכשל באימות. עד שתשלח ערך תקין עבור שדה זה, כל עדכון של ספק זה יענה על 400, כולל.UA-proxy_urlhttpsvalidation_error{}

כבה ספק

הנתיב עונה על 204 No Content ומרכז העזרה שלך מפסיק לטעון את הספק. ההגדרות שלו נשמרות, כך שהרשימה עדיין מציגה אותו עם enabled: false, ו-{} שנשלח לנתיב העדכון שלו מפעיל אותו מחדש.

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

שגיאות

curl -i -X POST "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/integrations/google-tag-manager/disable" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

סטָטוּס	כַּאֲשֵׁר	`code`
400	שדה נדרש חסר או ריק, ערך אינו תואם את הפורמט שלו או ארוך מ-255 תווים, ערך מאוחסן נכשל בעיצובו והגוף משמיט אותו, או שהגוף מכיל שדה לא ידוע	`validation_error`
403	למפתח חסר את טווח `read`, או `admin` עבור שינויים	`insufficient_scope`
403	התוכנית שלך אינה כוללת אינטגרציות, או שיוצר המפתח אינו יכול לשנות את מרכז העזרה הזה.	`permission_denied`
404	מרכז העזרה אינו קיים בסביבת העבודה שלך, או ש-`type` אינו ספק נתמך	`not_found`

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

שאלות נפוצות

האם ניתן להוסיף סקריפט מותאם אישית באמצעות ממשק ה-API Notiondesk?

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

למה המפתח שלי לא יכול להגדיר אינטגרציות?

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

האם השבתת אינטגרציה מוחקת את ההגדרות שלה?

לא. ההגדרות נשמרות, ושליחת {} לנתיב העדכון של הספק מפעילה אותו מחדש יחד איתן.

האם ניתן להשתמש במזהה `UA-` של Universal Analytics?

לא. ה-API מקבל רק מזהי מדידה של Google Analytics 4, המתחילים ב-G-.

מה הלאה

קבל ניתוח נתונים ממרכז העזרה עם ממשק ה-API Notiondesk

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

אימות באמצעות ממשק ה-API Notiondesk באמצעות מפתחות API

תוכן עניינים