סקירה

ה -API KEY הוא קוד אימות המשמש את המנפיק (קומבוקס) כדי לזהות את פלטפורמת הארגון שלך כאשר הוא מתקשר עם הפלטפורמה שלנו. כדי לאבטח את כלי הגישה רב העוצמתי הזה מפני שימוש על ידי מישהו מלבד הלקוח הספציפי של קומבוקס, הAPI Key הוצפן בתוך Secret (צופן סודי).

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

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

על מנת לגשת ל- API KEY ולהעתיק אותו:

1. נווטו אל הגדרות > מודולים > API KEY.
2. ודאו שהמפתח תקין על-ידי לחיצה על סמל הבדיקה. תיבת אישור ירוקה תופיע בפינה התחתונה של המסך.
3. לחצו על סמל התצוגה לצדו של ה- API KEY.
4. כאשר תיבת הדיאלוג נפתחת, לחצו על סמל העתק והדבקו אותו בכל מקום שבו הוא נחוץ במערכת הארגונית שלכם.

KEY API חדש נוצר באופן אוטומטי בלוח הזמנים שהוגדר מראש או לאחר 365 ימים כברירת מחדל. אפשר גם לבטל ולהנפיק מפתח API חדש מוקדם יותר מהסבב המתוזמן.

כדי לבטל את ה- API KEY הנוכחי:

1. נווטו אל הגדרות > מודולים > API KEY.

2. לחצו על סמל ביטול בקצה השמאלי של ה-KEY API הקיים.
   תיבת דיאלוג חדשה תודיע על תקופת התראה של 30 יום כדי להחליף את המפתח הישן במפתח החדש. לחצו על Revoke Key.

3. בתיבת הדיאלוג החדשה, קבעו כמה זמן ה- API KEY יהיה פעיל. אפשר להעתיק את המפתח משם למקומות אחרים או לעשות זאת מאוחר יותר במהלך תקופת הההתראה.

4. סיימו את התהליך על-ידי לחיצה על סיום.
   ה- API החדש מוצג מעל הישן. לאחר 30 יום, תוקף ה- API הישן יפוג.

5. אפשר למחוק את המפתח שבוטל / פג תוקפו על ידי לחיצה על אייקון פח האשפה .

שאלות ותשובות אודות API Key Rotation :

ש: מדוע ה-API Key משתנה?

ת: מפתח ה API קבוע ואינו משתנה עד שאנו מנפיקים מפתח חדש.
מפתח ה API מוצפן ב Secret (צופן סודי) עם רכיב תאריך שכשפג תוקפו, ה API Key לא יתקבל יותר על ידי המערכת שלנו. מרכיב זה עושה את השינוי בצופן מדי יום.

ש: כיצד אוכל לראות את מפתח ה API Key עצמו?

ת: כאשר שולפים את ה API Key מתוך ההצפנה שלו, ניתן למצוא אותו בקלות בתוך המערכת הארגונית.
כנסו לאתר ייעודי שמחלץ מידע מוצפן כגון www.jwt.io
והעתקו את ה API Key כפי שהוא מופיע במערכת קומבוקס והדבקו אותו בחלון השמאלי באתר.
הקוד השני בחלק המרכזי מצד ימין (בסגול) הוא ה API Key. (מופיע תחת Client secret)

ש: כיצד מפתחות ה API הישנים והחדשים יכולים לפעול בו זמנית?

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