מפתחות API לממשקים – מרכז התמיכה קארדקום

הגדרות ->ממשקים ומפתחים

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

העמוד מאפשר לנהל:

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

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

מפתחות API

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

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

כל מפתח כולל שני פרטים:

API Name – שם המשתמש של המפתח.

API Password – הסיסמה הסודית של המפתח.

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

צפייה במפתחות הקיימים

טבלת המפתחות מציגה את כל מפתחות ה-API של החברה, כולל:

שם המפתח
API Name
ההרשאות שהוגדרו לו
סטטוס המפתח – פעיל או מושבת

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

לחיצה על שורת המפתח או על הכפתור הרשאות תפתח את פרטי המפתח לעריכה.

יצירת מפתח API חדש

ליצירת מפתח חדש:

לחצו על מפתח חדש.
הזינו שם ברור שיאפשר לזהות את המערכת שתשתמש במפתח.
לחצו על המשך.
הגדירו את ההרשאות הנדרשות בכל מסוף.
לחצו על צור מפתח.
העתיקו ושמרו את ה-API Name ואת ה-API Password במקום מאובטח.
סמנו את השדה שמרתי את ה-API Password במקום מאובטח.
לחצו על סיום.

ה-API Password מוצג פעם אחת בלבד ואינו ניתן לשחזור. אם הסיסמה תאבד, יהיה צורך להחליף אותה.

לא ניתן ליצור מפתח חדש במקרים הבאים:

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

הרשאות פר מסוף

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

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

הרשאה זו מאפשרת למערכת החיצונית:

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

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

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

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

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

ביטול עסקה

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

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

עריכת מפתח קיים

במסך העריכה ניתן:

לשנות את שם המפתח
להפעיל או להשבית את המפתח
לעדכן הרשאות בכל מסופי החברה
להעתיק את ה-API Name
להחליף את ה-API Password

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

API Name

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

שם

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

השם חייב להכיל בין 2 ל-50 תווים ואינו יכול להיות זהה לשם של מפתח אחר בחברה.

מפתח פעיל

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

API Password

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

הפעלה והשבתה של מפתח

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

ניתן להשבית מפתח בשתי דרכים:

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

ניתן להפעיל את המפתח מחדש בכל שלב.

מפתח מושבת ממשיך להיספר במגבלה של 5 מפתחות לחברה.

החלפת סיסמת המפתח

אם ה-API Password אבד, נחשף או דורש החלפה:

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

הפעולה מחליפה גם את ה-API Name וגם את ה-API Password.

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

מידע חשוב בנושא אבטחה

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

שאלות נפוצות

האם ניתן להציג מחדש את ה-API Password?

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

האם ניתן למחוק מפתח API?

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

האם השבתת מפתח מוחקת את ההרשאות שלו?

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

האם יצירת מפתח API דורשת אימות מוגבר?

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