ממשק ה-API של REST Notiondesk מאפשר לך להפעיל את מרכזי העזרה שלך מקוד. קרא מאמרים, אוספים ורשומות ביומן שינויים, נהל הפניות של דפים, עדכן הגדרות, מיתוג ואינטגרציות, ייצא ניתוחים ומשוב קוראים, והפעל סנכרון מ-Notion. אתה עדיין כותב את התוכן שלך ב-Notion: ממשק ה-API קורא אותו ומסנכרן אותו, הוא לא עורך אותו.
כתובת אתר בסיסית
שלח כל בקשה אל https://api.notiondesk.so. נתיבי נקודות הקצה מתחילים ב-/sites, ובקשות ותגובות משתמשות ב-JSON.
אימות
כל בקשה נושאת אסימון נושא (bearer token) בכותרת Authorization:
curl https://api.notiondesk.so/sites \
-H "Authorization: Bearer $NOTIONDESK_API_KEY"- מפתח API : עבור הסקריפטים שלך, משימות מתוזמנות ו-CI. בעל סביבת העבודה או מנהל מערכת יוצרים אותו בהגדרות > מפתחים > מפתחות API. מפתחות מתחילים ב-
nd_wsk_ופועלים עבור כל מרכז עזרה בסביבת העבודה. ראה אימות באמצעות Notiondesk API באמצעות מפתחות API .
- אסימון גישה של OAuth : עבור אפליקציות שאליהן לקוחות Notiondesk אחרים מתחברים. ראה חיבור האפליקציה שלך ל-Notiondesk באמצעות OAuth .
כל נקודת קצה זקוקה להיקף אחד: read, write, sync או admin. הדף של כל נקודת קצה מציג איזו מהן.
דוגמאות קוד
כל דף קצה מפרט את הפרמטרים שלו, גוף הבקשה והתגובות, עם דוגמאות קוד מוכנות להעתקה ב-cURL, JavaScript ו-Python.
מדריכים
- התחל עם Notiondesk REST API : הבקשה הראשונה שלך, שלב אחר שלב.
- מדריכי התחלה : מפתחות API, OAuth, דפדוף וגירסאות, מגבלות שגיאות וקצב ודוגמאות.
- Webhooks : קבל בקשה בשרת שלך כאשר משהו קורה ב-Notiondesk.