התחל עם ממשק ה-API של REST Notiondesk

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

2 דקות קריאה

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

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

מה ניתן לעשות עם ממשק ה-API Notiondesk

מְשִׁימָה דוּגמָה מַדְרִיך
קראו את מרכזי העזרה שלכם רשום כל מרכז עזרה בסביבת העבודה שלך ואת השפות שלו קראו את מרכזי העזרה שלכם
קרא תוכן ייצוא כל מאמר כ-markdown, או רשום את ערכי יומן השינויים שלך קרא מאמרים, אוספים ורשומות ביומן שינויים
פרסום שינויים ברעיון סנכרן את מרכז העזרה שלך מצומת CI לאחר עריכת Notion סנכרון של Trigger Notion
ניהול הפניות ייבוא ​​מאות הפניות לאחר מעבר ממרכז עזרה אחר ניהול הפניות של דפים
שנה שפות הוסף שפה או הפעל תרגום אוטומטי ניהול שפות ותרגום אוטומטי
שינוי הגדרות עדכון כותרות SEO, llms.txt, טופס יצירת הקשר או יומן השינויים עדכון הגדרות מרכז העזרה
שינוי מיתוג החל את צבעי המותג והנושא שלך במספר מרכזי עזרה התאמה אישית של מיתוג וערכות נושא
ניהול אינטגרציות הגדר את גוגל אנליטיקס, Plausible, Intercom או Crisp ניהול אינטגרציות
ניתוחי משיכה שלח מבקרים, חיפושים ומאמרים מובילים לכלי ה-BI שלך קבל ניתוח נתונים של מרכז העזרה
קרא משוב שלח תגובות שליליות למאמרים לסלאק בכל בוקר ייצוא משוב הקוראים

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

מי יכול להשתמש בממשק ה-API Notiondesk

  • תוכנית: גישת API כלולה בתוכניות הארגוניות.
  • יצירת מפתחות: בעלי סביבת עבודה ומנהלים יוצרים מפתחות API בלוח המחוונים.

בצע את בקשת ה-API הראשונה שלך Notiondesk

1. צור מפתח API

בלוח המחוונים Notiondesk שלך, פתח את ההגדרות , לאחר מכן את מפתחים > מפתחות API , ולחץ על צור מפתח . תן לו תווית, בחר את טווח הקריאה והעתק את המפתח כאשר הוא מוצג. המפתח מתחיל ב-nd_wsk_ ומוצג פעם אחת בלבד.

אחסן אותו במשתנה סביבה:

2. רשום את מרכזי העזרה שלך

התגובה מפרטת כל מרכז עזרה בסביבת העבודה שלך:

3. רשימת מאמרים של מרכז עזרה

זהו! אתה קורא את מרכז העזרה שלך מהקוד.

יסודות ה-API של Notiondesk

export NOTIONDESK_API_KEY="nd_wsk_..."
curl "<https://api.notiondesk.so/sites>" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"
{
  "object": "list",
  "data": [
    {
      "id": "c74781f6-1aea-4e17-ab23-bbb8b4d174b6",
      "full_domain": "help.example.com",
      "enabled": true,
      "default_locale": "en",
      "locales": ["en", "fr"]
    }
  ],
  "has_more": false,
  "next_cursor": null
}
curl "<https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/articles?page_size=10>" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"
נוֹשֵׂא מה לדעת
כתובת אתר בסיסיתhttps://api.notiondesk.so
אימות Authorization: Bearer <key or access token>. ראה מפתחות API ו- OAuth
טווחים read, write, sync ו-admin. כל מסלול דורש אחד
ניהול גרסאות כותרת אופציונלית nd-version
פוּרמָט גופי בקשות ותגובה של JSON עם שמות שדות snake_case
דִפּוּף מבוסס סמן: page_size (1 עד 100, ברירת מחדל 20) ו-cursor. ראה בקשות לעמודים וגירסאות
שגיאות מעטפת JSON אחת עם code קריא על ידי מכונה. ראה טיפול בשגיאות, מגבלות קצב וניסיונות חוזרים.

Notiondesk ממשק API או MCP של סביבת עבודה?

Notiondesk מציע שתי דרכים להפעיל את מרכזי העזרה שלך מחוץ ללוח המחוונים. הן מגיעות לאותן תכונות דרך דלתות שונות.

Notiondesk ממשק API של REST סביבת עבודה MCP
מי קורא לזה הקוד שלך: סקריפטים, צינורות CI, כלים פנימיים, אפליקציות שותפים עוזר בינה מלאכותית כמו קלוד, צ'אטGPT, סמן או VS Code
איך זה נכנס מפתח API של סביבת עבודה, או אסימון גישה של OAuth OAuth, דרך לקוח הבינה המלאכותית שלך
הכי טוב עבור אוטומציה דטרמיניסטית וחוזרת על עצמה עבודת שיחה: "למצוא את המאמרים שהקוראים לא אוהבים ולהציע תיקונים"

Notiondesk נקודת קצה של ה-API

שִׁיטָה נָתִיב תְחוּם מַדְרִיך
GET/sitesreadמרכזי עזרה
GET/sites/{site_id}readמרכזי עזרה
GET/sites/{site_id}/sync-statusreadמרכזי עזרה
GET/sites/{site_id}/articlesreadתוֹכֶן
GET/sites/{site_id}/articles/{article_id}readתוֹכֶן
GET/sites/{site_id}/categoriesreadתוֹכֶן
GET/sites/{site_id}/categories/{category_id}readתוֹכֶן
GET/sites/{site_id}/changelogreadתוֹכֶן
POST/sites/{site_id}/syncsyncסנכרון
POST/sites/{site_id}/articles/{article_id}/syncsyncסנכרון
POST/sites/{site_id}/categories/{category_id}/syncsyncמסנכרנים
PATCH/sites/{site_id}/settings/auto-syncsyncסנכרון
GET/sites/{site_id}/page-redirectsreadהפניות
POST/sites/{site_id}/page-redirectswriteהפניות
PATCH/sites/{site_id}/page-redirects/{redirect_id}writeהפניות
DELETE/sites/{site_id}/page-redirects/{redirect_id}adminהפניות
PATCH/sites/{site_id}/settings/supported-languageswriteשפות
PATCH/sites/{site_id}/settings/auto-translatewriteשפות
PATCH/sites/{site_id}/settings/contentwriteהגדרות
PATCH/sites/{site_id}/settings/ai-optimizationwriteהגדרות
PATCH/sites/{site_id}/settings/contact-formwriteהגדרות
PATCH/sites/{site_id}/settings/changelogwriteהגדרות
GET/sites/{site_id}/settings/customizereadמיתוג
PATCH/sites/{site_id}/settings/customizeadminמיתוג
GET/sites/{site_id}/themesreadמיתוג
GET/sites/{site_id}/integrationsreadאינטגרציות
PATCH/sites/{site_id}/integrations/{type}adminאינטגרציות
POST/sites/{site_id}/integrations/{type}/disableadminאינטגרציות
GET/sites/{site_id}/analytics/{report}readאנליטיקס
GET/sites/{site_id}/feedbackreadמָשׁוֹב

שאלות נפוצות

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

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

האם מפתח API אחד עובד עבור כל מרכזי העזרה שלי?

כן. מפתח API של סביבת עבודה עובד עבור כל מרכז עזרה בסביבת העבודה שלו. כל בקשה נותנת שם למרכז העזרה בנתיב שלה, לדוגמה /sites/{site_id}/articles.

היכן אוכל למצוא את site_id של מרכז עזרה?

התקשרו ל-GET /sites כדי לרשום את מרכזי העזרה שלכם עם ה-id שלהם. זהו גם המזהה שאחרי /s/ בשורת הכתובת של לוח המחוונים שלכם.

מה הלאה

מאמרים קשורים

האם הדף הזה היה מועיל?

Still need help? Ask us