אימות ומפתחות API

זמין בתוכניותProResearch

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

לפני שמתחילים

תוכנית Pro או Research. חשבונות Free יכולים ליצור רק מפתחות MCP, שעובדים בשרת ה-MCP ולא ב-REST API. ראו חיבור לקוח MCP.

יצירת מפתח

פתחו את הגדרות ובחרו API ו-MCP.
תחת מפתחות API לחצו על יצירת מפתח.
הקלידו שם המפתח שאומר לכם איפה המפתח בשימוש, למשל nightly-sync.
סמנו את הרשאות שהמפתח צריך ולא יותר. הרשאות כתיבה מאפשרות למפתח לשנות את הספרייה שלכם, לכן תנו אותן רק לסקריפטים שאתם סומכים עליהם.
לחצו על יצירה.
העתיקו את המפתח עכשיו. הוא מתחיל ב-pk_, ו-Readsira מציגה אותו פעם אחת בלבד. אחר כך הרשימה מציגה צורה מקוצרת כמו pk_1a2b...9z8y.

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

שליחת המפתח עם בקשה

שלחו את המפתח בכותרת Authorization כאסימון נושא (bearer):

curl https://api.readsira.com/rest/v2/usage \
  -H "Authorization: Bearer $READSIRA_KEY"

גם הכותרת X-API-Key עובדת:

curl https://api.readsira.com/rest/v2/usage \
  -H "X-API-Key: $READSIRA_KEY"

מפתח בכתובת (?api_key=pk_...) נדחה עם 401 והקוד API_KEY_IN_QUERY, כי כתובות מגיעות ליומנים ולהיסטוריית הדפדפן.

שמרו את המפתח במשתנה סביבה או במאגר סודות. אל תשימו אותו בקוד שנשמר ב-commit, בדף אינטרנט או באפליקציה שאתם מפיצים לאנשים אחרים.

בדיקה שזה עובד

GET /rest/v2/usage עונה עבור כל הרשאה. הוא מראה את התוכנית שלכם, את מספר הבקשות של היום ואת המגבלות של המפתח הזה.

{
  "success": true,
  "data": {
    "plan": "pro",
    "requestsToday": 12,
    "requestsPerDay": 10000,
    "mcpCallsToday": 0,
    "mcpCallsPerDay": 10000,
    "requestsPerHour": 600,
    "askAnswersPerMonth": 300,
    "aiBudget": [{ "group": "chat", "percentUsed": 3 }]
  },
  "meta": {
    "timestamp": "2026-11-04T09:00:00.000Z",
    "path": "/rest/v2/usage",
    "method": "GET",
    "statusCode": 200
  }
}

המספרים למעלה הם דוגמה; אצלכם אלה המגבלות של התוכנית שלכם. אם הקריאה עונה 401, המפתח שגוי, בוטל או שפג תוקפו. אם היא עונה 402 PLAN_REQUIRED, החשבון ב-Free. ראו מגבלות קצב ושגיאות.

איזו הרשאה נדרשת לנתיב

נתיב דוחה מפתח בלי ההרשאה שלו עם 403 SCOPE_REQUIRED. מדריך העזר נותן שם להרשאה מתחת לכל נתיב. הנפוצות ביותר:

הרשאה	מאפשרת למפתח
`read:library`	לחפש, לקרוא מסמכים, קטעים ותמלולים
`ask:library`	לשאול שאלות שנענות עם ציטוטים (משתמש בתקציב ה-AI שלכם)
`read:projects`	לרשום פרויקטים ולקרוא את ההקשר שלהם
`write:projects`	להוסיף מקורות והערות לפרויקטים
`write:uploads`	להעלות קובצי אודיו, וידאו ו-PDF
`read:bookmarks`, `write:bookmarks`	לקרוא ולכתוב סימניות בנתיבי `/api/v1/bookmarks`
`read:collections`	לקרוא אוספים בנתיבי `/api/v1/collections`

יצירת מפתח עם הרשאה שהתוכנית שלכם אינה כוללת עונה 400 SCOPE_NOT_ALLOWED.

החלפה או הסרה של מפתח

בשורה של המפתח פתחו את תפריט הפעולות.

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

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

טיפים

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

לפני שמתחילים​

יצירת מפתח​

שליחת המפתח עם בקשה​

בדיקה שזה עובד​

איזו הרשאה נדרשת לנתיב​

החלפה או הסרה של מפתח​

טיפים​

קשור​