כלים למפתחים

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

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

• מפתח לא פעיל נשאר ברשימה אבל לא מאפשר גישה ל-API.

ה-Webhook לתשלומים הוא כתובת URL שמגדירים כאן, ושתקבל התראה אוטומטית מהמערכת בכל פעם שמתבצע תשלום כלשהו בחשבון, כלומר אינטגרציה בכיוון ההפוך, שבה המערכת יוזמת פנייה למערכת חיצונית שלכם, במקום שאתם תפנו אליה. יכולת זו שימושית לחיבור המערכת לכלי פנימיים, כמו מערכת הנהלת חשבונות, מערכת התראות פנימית או פלטפורמת אנליטיקה, שמעוניינים לקבל עדכון בזמן אמת על כל תשלום מבלי לבדוק באופן יזום מול ה-API. חשוב לשים לב לדרישה טכנית מחייבת: הכתובת שמוגדרת חייבת להיות כתובת HTTPS מאובטחת, ולא כתובת HTTP רגילה, שכן המערכת אינה שולחת נתונים רגישים לכתובת שאינה מוצפנת.

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