קרא מאמרים, אוספים ורשומות ביומן שינויים בעזרת ממשק ה-API Notiondesk

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

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

בממשק ה-API Notiondesk, אוסף נקרא קטגוריה .

בחר את השפה

כל נתיב בדף זה מקבל פרמטר שאילתה אופציונלי locale, כגון ?locale=fr. בלעדיו, התגובה משתמשת בשפת ברירת המחדל של מרכז העזרה. ברשימת הנתיבים, locale חייבת להיות אחת מהשפות שמרכז העזרה משרת: supported_locales של מרכז העזרה . קרא תמיכה בשפות מרובות במרכז העזרה שלך כדי להוסיף שפות.

רשימת מאמרים

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

curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/articles?page_size=100&locale=en" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

{
  "object": "list",
  "data": [
    {
      "id": "1761580412",
      "title": "Connect your Notion workspace",
      "slug": "connect-your-notion-workspace",
      "status": "published",
      "categories": [
        {"id": "910000002", "name": "Connecting Notion", "slug": "connecting-notion", "locale": "en", "status": "published"}
      ],
      "tags": [{"name": "Setup", "slug": "setup"}],
      "locales_count": 2,
      "updated_at": "2026-10-18T14:39:03+00:00",
      "published_at": "2026-10-05T04:39:04+00:00",
      "locale": "en",
      "reading_time": 3,
      "views_count": 42,
      "reactions_percent": {"smiley": 50, "neutral_face": 25, "disappointed": 25},
      "source_notion_page_id": "3d5001d0-2470-8122-a1b2-c3d4e5f60789",
      "notion_article_page_url": "https://www.notion.so/3d5001d024708122a1b2c3d4e5f60789",
      "sync_in_progress": false,
      "sync_timeout": false,
      "sync_failed": false,
      "sync_error_code": null,
      "auto_translated": false
    }
  ],
  "has_more": true,
  "next_cursor": "OPAQUE_CURSOR"
}

הערה: סנן את התוצאות בקוד שלך כדי למצוא כל מאמר שהסנכרון האחרון שלו נכשל, לאחר מכן תקן אותו ב-Notion וסנכרן אותו שוב .sync_failed: true

קרא מאמר כהורדת מחיר

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

{
  "id": "1761580412",
  "type": "article",
  "title": "Connect your Notion workspace",
  "slug": "connect-your-notion-workspace",
  "text": "# Connect your Notion workspace\n\nOpen **Settings**, then **Notion**...",
  "url": "https://help.example.com/en/articles/connect-your-notion-workspace",
  "locale": "en",
  "last_updated": "2026-10-18T14:39:03+00:00",
  "category": {"id": "910000002", "title": "Connecting Notion", "slug": "connecting-notion"},
  "tags": ["setup"],
  "truncated": false,
  "author": {"name": "Ada Lovelace"},
  "status": "published",
  "content_available": true,
  "sync_in_progress": false,
  "sync_timeout": false,
  "sync_failed": false,
  "sync_error_code": null
}

כל סטטוס קריא, כך שתוכל לקרוא טיוטה לפני שאתה מפרסם אותה. מאמר ללא תרגום ב-locale המבוקש עונה על שאלה 404 not_found.

רשימת אוספים

כל פריט הוא אוסף בשפה המבוקשת, לפי הסדר בו נוצרו האוספים:

בנה מחדש את עץ האוסף שלך עם שלושה שדות:

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

{
  "id": "910000001",
  "name": "Getting Started",
  "slug": "getting-started",
  "updated_at": "2026-10-18T14:39:12+00:00",
  "locale": "en",
  "is_parent": true,
  "source_notion_page_id": "5d5001d0-2470-8122-a1b2-c3d4e5f60789",
  "notion_category_page_url": "https://www.notion.so/5d5001d024708122a1b2c3d4e5f60789",
  "sync_in_progress": false,
  "sync_timeout": false,
  "sync_failed": false,
  "sync_error_code": null,
  "parent_ids": [],
  "children_ids": ["910000002"],
  "locales_count": 2,
  "status": "published",
  "auto_translated": false
}

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

קרא אוסף

לתגובה יש את אותה צורה כמו של מאמר: type הוא category, title, slug, url, status, שדות הסינכרון, ו-text עם תוכן האוסף עצמו כהורדה, ריק כאשר אין בו.

רשימת ערכי יומן שינויים

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

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

curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/changelog?page_size=50&locale=en" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

{
  "object": "list",
  "data": [
    {
      "id": "article:1761497350",
      "title": "Multilingual sync is now available",
      "slug": "multilingual-sync-is-now-available",
      "text": "Help centers on the Enterprise plan can now sync every configured locale in a single run instead of one language at a time.",
      "published_at": "2026-10-13T09:12:44+00:00",
      "last_updated": "2026-10-18T14:39:03+00:00",
      "tags": [],
      "url": "https://help.example.com/en/changelogs",
      "locale": "en"
    }
  ],
  "has_more": true,
  "next_cursor": "OPAQUE_CURSOR"
}

טוב לדעת:

• ערך מופיע רק כאשר אוסף יומן השינויים שלו מתפרסם בשפה המבוקשת.

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

• הרשימה מגיעה לכל היותר ל-1,000 הערכים החדשים ביותר. מעבר לכך, has_more נשאר false גם כאשר קיימים ערכים ישנים יותר.

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

שגיאות

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

שאלות נפוצות

מה הלאה

• Trigger Notion מסתנכרן עם ממשק ה-API Notiondesk

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

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