ממשק ה-API Notiondesk מאפשר לך לפרסם את העריכות שלך ב-Notion ברגע שהן מוכנות: סנכרן מרכז עזרה שלם, אוסף אחד או מאמר אחד, מתוך סקריפט, צינור CI או כלי משלך. ניתן גם להפעיל או לכבות סנכרון מתוזמן. התוכן שלך נשאר ב-Notion; סנכרון קורא אותו שוב ומפרסם את השינויים.
| שִׁיטָה | נָתִיב | תְחוּם | האם |
|---|---|---|---|
POST | /sites/{site_id}/sync | sync | מסנכרן את כל מרכז העזרה |
POST | /sites/{site_id}/categories/{category_id}/sync | sync | מסנכרן אוסף אחד ואת המאמרים שלו |
POST | /sites/{site_id}/articles/{article_id}/sync | sync | מסנכרן מאמר אחד |
PATCH | /sites/{site_id}/settings/auto-sync | sync | הפעלה או כיבוי של סנכרון מתוזמן |
חדש בסנכרון? קרא תחילה כיצד לסנכרן את מרכז העזרה שלך עם Notion .
סנכרון מרכז עזרה שלם
Notiondesk קורא כל מאמר ואוסף מ-Notion שוב ומפרסם את השינויים. הנתיב עונה ל-204 No Content ברגע שהסנכרון נכנס לתור, והסנכרון פועל ברקע.
רק סנכרון אתר אחד פועל בכל פעם. בזמן שסנכרון של מרכז העזרה נמצא בתור או פועל, בין אם הוא תוזמן, הופעל מלוח המחוונים או הופעל דרך ה-API, טריגר אחר עונה על 409 conflict_error. המתן מספר דקות והפעל שוב.
תוכן שלא השתנה מאז הסנכרון האחרון שלו לא מתורגם שוב.
סנכרן אוסף אחד
השתמש בקובץ id של האוסף מרשימת האוספים . Notiondesk קורא שוב את האוסף וכל אחד מהמאמרים שלו מ-Notion, ולאחר מכן מפרסם רק את המאמרים שנערכו מאז הסנכרון האחרון שלהם. מאמרים שלא שונו אינם מתורגמים או מחויבים שוב.
סנכרן מאמר אחד
השתמש ב-id של המאמר מרשימת המאמרים .
curl -i -X POST "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/sync" \
-H "Authorization: Bearer $NOTIONDESK_API_KEY" \
-H "nd-version: 2026-10-16" \
-H "Idempotency-Key: 9b2e4c1a-sync-after-notion-edit"curl -i -X POST "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/categories/1761493027/sync" \
-H "Authorization: Bearer $NOTIONDESK_API_KEY" \
-H "nd-version: 2026-10-16" \
-H "Idempotency-Key: 2c8e5b7d-sync-billing"curl -i -X POST "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/articles/1761580412/sync" \
-H "Authorization: Bearer $NOTIONDESK_API_KEY" \
-H "nd-version: 2026-10-16" \
-H "Idempotency-Key: 4d7a0f3e-sync-getting-started"כיצד סנכרון אוספים ומאמרים שונה מסנכרון אתר
| סנכרון אתרים | סנכרון אוסף או מאמרים | |
|---|---|---|
| קריאה מתוך מושג | כל מאמר וקובץ | אוסף אחד ומאמריו, או מאמר אחד |
| בזמן שסנכרון נוסף של אותו פריט פועל | תשובות 409 __נשמר_45__ | מעביר סינכרון נוסף לתור. זה אף פעם לא עונה conflict_error |
| מוגבל על ידי | סנכרון אחד בכל פעם | תקציב הכתיבה של המפתח שלך הוא 20 בקשות לדקה |
כל סנכרון שהושלם מרענן את כל מרכז העזרה. הפעל סנכרון פעם אחת לאחר כל עריכה ב-Notion, לא לפי טיימר. לעדכונים קבועים, השתמש במקום זאת בסנכרון מתוזמן.
אישור סנכרון
טריגר סינכרון עונה על 204 כאשר הסינכרון נמצא בתור, לא כשהוא מסתיים. סינכרונים שהחלו דרך ה-API אינם מופיעים במצב הסינכרון , אשר מפרט רק את ההרצה המתוזמנת.
כדי לאשר סינכרון, קראו את התוכן שהוא מפרסם:
- הפעל את הסנכרון ורשום את הזמן.
- קרא את המאמר הערוך עם
GET /sites/{site_id}/articles/{article_id}כל 30 שניות.
- עצור כאשר
last_updatedמאוחר יותר מהזמן שציינת, או ש-textמציג את העריכה שלך.
- אם
sync_failedהואtrue,sync_error_codeאומר למה. תקן את המאמר ב-Notion וסנכרן שוב.
הפעלה או כיבוי של סנכרון מתוזמן
curl -i -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/settings/auto-sync" \
-H "Authorization: Bearer $NOTIONDESK_API_KEY" \
-H "nd-version: 2026-10-16" \
-H "Content-Type: application/json" \
-d '{"auto_sync_enabled": true}'| שָׂדֶה | סוּג | הערות |
|---|---|---|
auto_sync_enabled | בוליאני | האם Notiondesk מסתנכרן מ-Notion לפי לוח זמנים |
המסלול עונה על 204 No Content. קרא את המצב החדש ב-auto_sync_enabled של מרכז העזרה , ואת לוח הזמנים במצב הסנכרון שלו.
- שלח את ערכי ה-JSON הבוליאניים
trueאוfalse. הערכים0ו-"false"נקראים כ-true.
- לא ניתן לשנות את תדירות הסנכרון דרך ה-API: שולח
auto_sync_frequencyתשובות 400validation_error. שנה זאת בלוח המחוונים.
- התוכנית שלך חייבת לכלול סנכרון מתוזמן.
- הפעלת סנכרון מתוזמן מאפשרת לסנכרונים ללא השגחה להתחיל תרגום מחויב בזמן שהתרגום האוטומטי מופעל.
נתיב זה זקוק להיקף sync, לא write, מכיוון שהוא מחליט מתי פועלים סנכרונים ללא השגחה.
שגיאות
| סטָטוּס | כַּאֲשֵׁר | code |
|---|---|---|
| 400 | סנכרון אוטומטי בלבד: לגוף יש שדה לא ידוע, כולל auto_sync_frequency | validation_error |
| 403 | למפתח חסר ההיקף sync | insufficient_scope |
| 403 | מרכז העזרה מושבת, התוכנית שלך אינה כוללת סנכרון מתוזמן, או שיוצר המפתח אינו יכול לסנכרן את מרכז העזרה הזה. | permission_denied |
| 404 | מרכז העזרה, האוסף או המאמר אינם קיימים בסביבת העבודה שלך | not_found |
| 409 | סנכרון אתר בלבד: סנכרון של מרכז העזרה כבר בתור או פועל | conflict_error |
| 409 | בקשה עם אותו Idempotency-Key עדיין נמצאת בעיבוד | request_in_progress |
conflict_error ו-request_in_progress הן שגיאות שונות עם אותו סטטוס: branch on code. ראה טיפול בשגיאות API, מגבלות קצב וניסיונות חוזרים של Notiondesk .
שאלות נפוצות
האם בטוח לנסות שוב טריגר סנכרון?
כן, עם Idempotency-Key. ניסיון חוזר עם אותו מפתח עונה על 204 עם X-Idempotent-Replay: true ולא שם דבר בתור, אפילו בזמן שהסנכרון הראשון עדיין פועל.
איך אני יודע מתי הסנכרון הסתיים?
קרא את המאמר או האוסף המסונכרנים עד ש-last_updated יגיע מאוחר יותר מהטריגר שלך, או ש-text יציג את העריכה שלך. אל תסתמך על sync_in_progress בלבד: הוא יכול להישאר false למשך מספר שניות לאחר הטריגר, לפני שהסנכרון בתור מתחיל. סנכרונים המופעלים על ידי API אינם רשומים במצב הסנכרון.
האם עליי לסנכרן מאמר אחד או את כל מרכז העזרה?
סנכרן מאמר אחד לאחר עריכת מאמר זה, ואוסף אחד לאחר עריכת מספר מאמרים בו. סנכרן את כל מרכז העזרה לאחר שינויים גדולים יותר, כגון העברת מאמרים בין אוספים.
האם ניתן לסנכרן מ-GitHub Actions?
כן. אחסן את המפתח כסוד של מאגר וקרא לנתיב סנכרון האתר בשלב זרימת עבודה. ראה אוטומציה של משימות נפוצות במרכז העזרה באמצעות ממשק ה-API Notiondesk .