ממשק החיפוש (Search API)

ממשק החיפוש (Search API)

חיפוש בסיסי

קלט:

משתנה תיאור
api_key מפתח אישי (משתנה חובה) שהמשתמש מקבל בעת הרישום למערכת ממשקי ה- API של הספריה הלאומית. יש להשתמש במפתח כערך עבור הפרמטר: {USER_KEY}.
search_string שאילתת חיפוש בסיסית (משתנה חובה). המחרוזת חייבת לכלול לפחות שלושה תווים עבור אחד ממשתני החיפוש מסוג טקסט, או אחד מהשדות הבאים: system_number, shelfmark

דוגמא לחיפוש בסיסי

כללים וערכים חוקיים לבניית שאילתת החיפוש זמינים כאן.

דוגמא לחיפוש בסיסי: https://api.nli.org.il/openlibrary/search?api_key={USER_KEY}&query=title,exact,Jerusalem

חיפוש מתקדם

קלט:

משתנה ראשי משתנה משני תיאור
api_key api_key מפתח אישי (משתנה חובה) שהמשתמש מקבל בעת הרישום למערכת ממשקי ה- API של הספריה הלאומית. יש להשתמש במפתח כערך עבור הפרמטר: {USER_KEY}.
search_string   מכיל שאילתת חיפוש (משתנה חובה), ופרמטרים אופציונליים נוספים. מחרוזת החיפוש חייבת לכלול לפחות שלושה תווים עבור אחד ממשתני החיפוש מסוג טקסט או אחד מהשדות - system_number, shelfmark.
הפרמטרים אופציונליים הנוספים הם : material_type, output_format, accessibility, sort_field, count_mode, items_per_page, result_page
  query שאילתת (חובה) שהיא חלק מ-search_string, ותומכת בסינון לפי מגוון פרמטרים. כללים וערכים חוקיים לשאילתת החיפוש כוללים את החוקים הבאים וגם זמינים כאן.
  • רשימת פרמטרים שניתן לתשאל (למשל: title)
  • כללי יחס חוקיים להשוואת פרמטרים (exact, contains)
  • קיצורי שם שפה סטנדרטיים
  • פורמט חוקי עבור תאריך
  material_type רשימת ערכים חוקיים ל-material_type נמצאת כאן
  output_format רשימת ערכים חוקיים ל-output_format נמצאת כאן
  availability_type רשימת ערכים חוקיים ל-availability_type נמצאת כאן
  sort_field רשימת ערכים חוקיים ל-sort_field נמצאת כאן
  count_mode Yes / No (ברירת מחדל=no)

דוגמא למחרוזת לפרמטר query (שהינו חלק מה-search_string):

query=title,exact,jerusalem,AND;creator,contains,Jerusalem,AND;language,exact,eng,AND;start_date,contains,1951&sortField=title&output_format=xml

דוגמא לחיפוש מתקדם:

https://api.nli.org.il/openlibrary/search?api_key={USER_KEY}&query=title,exact,jerusalem,AND;creator,contains,Jerusalem,AND;language,exact,eng,AND;start_date,contains,1951&sortField=title&output_format=xml

משתמש אורח

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

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

אנו ממליצים לבצע רישום למערכת שלנו כדי לקבל את החוויה המלאה.

מפתח של משתמש אורח: DVQyidFLOAjp12ib92pNJPmflmB5IessOq1CJQDK