מפתחות API

מפתחות API מאמתים בקשות אל ה-API הציבורי של /v1. כל מפתח שייך לחשבון שירות ונוצר מעמוד הפרטים של אותו חשבון ב-Developer Hub. השתמשו במפתח API מוגבל-היקף עבור אינטגרציית צד שרת פרטית כאשר אחסון מאובטח ורוטציה של סוד עומדים בדרישות הארגון שלכם. אין צורך בלקוח OAuth או בהחלפת אסימונים. ראו אימות אם הארגון שלכם דורש במקום זאת אסימוני גישה קצרי מועד של OAuth.

​

מבנה המפתח

• מזהה — מתחיל ב-ak_. בטוח להפניה בתקלות (tickets), ביומנים ובהגדרות תצורה; הוא אינו מעניק דבר בפני עצמו.
• סוד — מתחיל ב-lsk_live_. זהו פרט הגישה שהאינטגרציה שלכם מציגה. הוא מוצג פעם אחת, בעת היצירה או הרוטציה, ולא ניתן לאחזר אותו לאחר מכן. רשימת המפתחות מציגה רק את ארבעת התווים האחרונים (לדוגמה lsk_live_…xQc4) כדי שתוכלו להתאים שורה לפרט הגישה שברשות הקורא.
• הרשאות — תת-קבוצה של ההרשאות של חשבון השירות הבעלים, הנבחרת בעת היצירה. מפתח לעולם אינו יכול לבצע יותר ממה שהחשבון שלו מאפשר.
• תפוגה — חובה. לכל מפתח יש תאריך תפוגה.

​

יצירת מפתח

בעמוד הפרטים של חשבון השירות, יוצרים מפתח בארבעה שלבים: נותנים לו שם, בוחרים את ההרשאות שהמפתח הספציפי הזה נדרש להן, בוחרים תפוגה — 30, 90 או 365 ימים, או תקופה מותאמת אישית של עד שנה — וסוקרים. הסוד מוצג בסיום, פעם אחת. הגבילו כל מפתח לקבוצת ההרשאות הצרה ביותר שהקורא שלו צריך, גם אם החשבון מתיר יותר. אם מפתח דולף, ההרשאות שלו קובעות את היקף הנזק.

​

רוטציה ללא השבתה

רוטציה מנפיקה סוד חדש ומתחילה חלון חפיפה — שעה אחת, 24 שעות או 7 ימים — שבמהלכו הסוד הישן ממשיך לפעול. כך תוכלו להפיץ את הסוד החדש בין סביבות הפריסה שלכם בקצב שלכם: בצעו רוטציה גם לפני התפוגה: מפתחות שמתקרבים לתאריך התפוגה שלהם מסומנים ברשימת המפתחות כמפתחות שעומדים לפוג. מפתח שפג תוקפו מפסיק לאמת — בקשות שנשלחות באמצעותו מחזירות 401 עם הקוד credential_expired.

​

ביטול מיידי

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