הגדרות ->1. הגדרות חברה ומשתמשים ->4. ניהול מפתחות API לממשקים

ניהול מפתחות API לממשקים

תוכן העמוד

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

באמצעות מפתח API ניתן לאפשר לתוכנות, לאתרי אינטרנט ולמערכות חיצוניות לבצע פעולות באופן אוטומטי, כגון:

• חיוב כרטיסי אשראי.
• הפקת מסמכים.
• זיכוי כרטיס או אסימון.
• ביטול עסקאות.
• התחברות למערכת באמצעות SSO.

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

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

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

בחירת מפתח API

מפתח להגדרות

רשימה לבחירת אחד ממפתחות ה-API הקיימים בחשבון.

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

אם עדיין לא נוצרו מפתחות API בחשבון, תוצג הודעה שיש ליצור מפתח חדש.

מפתח חדש

כפתור ליצירת מפתח API חדש.

בלחיצה על הכפתור המערכת יוצרת באופן אוטומטי:

• שם משתמש לממשק - API Name.
• סיסמה לממשק - API Password.

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

ניתן ליצור עד 5 מפתחות API בחשבון. בניסיון ליצור מפתח נוסף תוצג הודעה כי הגעתם למספר המפתחות המרבי.

פרטי המפתח

API Name

המזהה הייחודי של מפתח ה-API, המשמש כשם המשתמש בעת ההתחברות לממשק.

הערך נוצר אוטומטית על ידי המערכת ומוצג לקריאה בלבד.

לא ניתן לערוך את ה-API Name.

API Password

הסיסמה הסודית של המפתח, המשמשת יחד עם ה-API Name לצורך התחברות לממשק.

הערך נוצר אוטומטית על ידי המערכת ומוצג לקריאה בלבד.

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

הגדרות המפתח

תיאור מפתח API

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

לדוגמה:

• אתר המכירות.
• חיבור למערכת CRM.
• תוסף WooCommerce.
• מערכת הנהלת חשבונות.

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

כללי תקינות: ניתן להזין עד 50 תווים.

מפתח API פעיל?

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

• כאשר האפשרות מסומנת — המפתח פעיל.
• כאשר האפשרות אינה מסומנת — המפתח מושבת ולא ניתן להתחבר באמצעותו.

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

SSO פעיל?

מאפשר להשתמש במפתח לצורך חיבור באמצעות SSO.

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

הסבר נוסף זמין במאמר על ממשק SSO המקושר ליד השדה.

משתמש SSO

בחירת המשתמש בחשבון שאליו ישויכו הכניסות והפעולות המתבצעות באמצעות ממשק ה-SSO.

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

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

מפתח API אחד יכול לקבל הרשאות למספר מסופים בחשבון.

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

בחר מסוף

רשימה לבחירת המסוף שעבורו יוגדרו הרשאות המפתח.

לאחר בחירת המסוף, יוצגו ההרשאות הקיימות של המפתח במסוף זה.

הרשימה תהיה זמינה רק לאחר בחירת מפתח API.

חיוב והפקת מסמכים

מתיר למפתח לבצע במסוף הנבחר פעולות כגון:

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

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

זיכוי כרטיס אשראי או אסימון

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

זיכוי מסוג זה אינו חייב להיות מקושר לעסקת מקור.

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

ביטול עסקה

מתיר למפתח לבטל עסקה קיימת במסוף הנבחר.

הביטול חייב להתבצע באמצעות ממשק הביטול המתאים ובהתייחס לעסקת המקור.

שליחת מפתח API באימייל

אימייל

בשדה זה ניתן להזין כתובת אימייל ולשלוח אליה את פרטי הגישה של המפתח.

האימייל כולל את:

• שם המשתמש של המפתח.
• סיסמת המפתח.
• פרטי החברה.
• פרטי המסוף שנבחר.

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

לפני שליחת האימייל המערכת שומרת את ההגדרות הנוכחיות של המפתח.

כללי תקינות:

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

מומלץ לוודא שהאימייל נשלח לגורם מורשה בלבד, מאחר שהוא מכיל פרטי גישה רגישים.

שמירת השינויים

לחיצה על שמור שומרת את הגדרות המפתח הנבחר, ובהן:

• תיאור המפתח.
• מצב פעיל או מושבת.
• הפעלת SSO.
• משתמש ה-SSO המשויך.
• הרשאת חיוב והפקת מסמכים.
• הרשאת זיכוי.
• הרשאת ביטול עסקה.
• ההרשאות עבור המסוף שנבחר.

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

בסביבת בדיקות לא ניתן לשמור שינויים. במקרה כזה תוצג הודעה מתאימה.

דגשים חשובים

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

⚠️ שגיאת 2FA?

אם הופיעה הודעת שגיאה הקשורה לאימות דו-שלבי (2FA) – יש להפעיל את האפשרות הזו במערכת.

בלחיצה על המלל הכחול "יש להפעיל אימות מוגבר (2FA)", תועברו ישירות לעמוד פרטי המשתמש, שם ניתן להפעיל את האימות הדו-שלבי.

📸 תמונות להמחשה:

• הודעת השגיאה:
  

• שדה להפעלת ה־2FA:
  

📘 למידע נוסף, ניתן להיעזר במדריך המצורף שמסביר שלב אחר שלב כיצד להפעיל את האימות הדו-שלבי (2FA).

אימות מוגבר במערכת קארדקום – הפעלת 2FA