/v1,
מקובצות לפי משאב, כשהאימות מוגדר מראש.
הורדה
קישורי ההורדה יבקשו מכם להתחבר באמצעות חשבון Living Security שלכם
לפני שהקובץ יסופק.
אוסף Living Security API v1
Postman Collection v2.1 הכולל את כל פעולות
/v1 ואימות Basic
מוגדר מראש. baseUrl של האוסף ריק — יש לבחור סביבה אזורית
לפני ששולחים בקשה.הורדת האוסףסביבת Production (US)
baseUrl מוגדר מראש ל-https://api.us-east-1.livingsecurity.ai/v1, עם
משתנים ריקים apiKeySecret ו-contractVersion למילוי.הורדת סביבת הייצור של USסביבת Production (EU)
baseUrl מוגדר מראש ל-https://api.eu-west-1.livingsecurity.ai/v1, עם
משתנים ריקים apiKeySecret ו-contractVersion למילוי.הורדת סביבת הייצור של EUתבנית סביבה
אותם משתנים עם
baseUrl ריק, עבור סביבות שאינן סביבות ייצור.הורדת תבנית הסביבההגדרה ב-Postman
1
ייבוא הקבצים
ב-Postman, בחרו Import וגררו פנימה את קובץ האוסף יחד עם סביבת
Production (US) או Production (EU) התואמת
לארגון. ראו אזורים.
2
יצירת מפתח API
בלוח המחוונים, פתחו הגדרות → Integrations & Developers →
Developer Hub, צרו חשבון שירות וצרו מפתח API. סוד המפתח מתחיל ב-
lsk_live_ ו
מוצג פעם אחת בלבד — העתיקו אותו מיד. לפרטים נוספים ראו
מפתחות API.3
הדבקת הסוד
הגדירו את המשתנה
apiKeySecret — בסביבה שיובאה
(מומלץ; זהו משתנה מסוג סוד) או בלשונית
Variables של האוסף.4
שליחת בקשה
בחרו את הסביבה האזורית שיובאה, פתחו כל בקשה — לדוגמה
Organization → Retrieve the organization — ולחצו Send. אין
לשלוח בקשה לפני שנבחרה סביבה;
baseUrl של האוסף ריק
במכוון.כיצד האימות מוגדר מראש
האוסף מגדיר אימות Basic ברמת האוסף עם שם משתמשapikey
וסיסמה {{apiKeySecret}}. ה-API מקבל את סוד המפתח בכל אחד משדות
אימות Basic, ולכן הדבר פועל כמות שהוא לאחר הגדרת המשתנה.
אם ברצונכם להשתמש באימות Bearer, שנו את סוג Authorization של האוסף
ל-Bearer Token והשתמשו ב-{{apiKeySecret}} כאסימון — ה-API
מקבל את אותו סוד בשני האופנים.
שימוש בכותרת Bearer עם מפתח API אינו דורש OAuth. כדי להשתמש ב-OAuth,
הגדירו את Bearer Token כאסימון הגישה של OAuth במקום סוד מפתח ה-API.
ראו אימות לבחירת שיטה ו-
OAuth client credentials להגדרת האסימון והלקוח.
כותרת גרסת החוזה
כל בקשה כוללת כותרתLiving-Security-Version המוגדרת מראש ל-
{{contractVersion}}, והיא מושבתת כברירת מחדל. השאירו אותה מושבתת כדי להשתמש בגרסת החוזה
הנעוצה של הארגון שלכם. הפעילו אותה כדי לנעוץ את הבקשה
לגרסה שפורסמה ספציפית — לגרסאות שפורסמו ראו את יומן השינויים.
פרמטרי שאילתה וגופי בקשות
מסנני נקודות הקצה מסוג רשימה (limit, page_token ומסננים ייעודיים למשאב)
כלולים בכל בקשה אך מושבתים, כך שייבוא חדש קורא לכל
נקודת קצה בהצלחה. הפעילו ומלאו את אלה שדרושים לכם — ראו
עימוד להסבר כיצד page_token פועל. גופי
הבקשות בפעולות POST ממולאים מראש בערכי מציין מיקום מטיפוסים מתאימים.
האוסף נוצר מחדש מפרט OpenAPI שפורסם בכל שינוי
בחוזה — הורידו עותק עדכני במקום לערוך בקשות
שברצונכם לשמור עדכניות.