לדלג לתוכן הראשי

מתחילים עם ה-API: מפתחות, userId והקריאה הראשונה

מאיפה לוקחים clientId/clientSecret, איך מגבילים את המפתח לקריאת מידע בלבד, מהו userId, ואיך מגיעים מהטוקן לקריאה הראשונה.

נכתב על ידי Eliron Giny

רוצה להתחיל לעבוד מול ה-API של Open Finance? הנה הצעדים — מקבלת המפתחות ועד הקריאה הראשונה.


1. קבל את מפתחות ה-API

גישה תכנותית (מפתח API) זמינה בתוכניות בתשלום (Starter ו-Pro). מיקום המפתחות תלוי במוצר שבו נרשמת:

  • משתמשי Financy: את ה-clientId וה-clientSecret מוצאים בתוך Financy, תחת הגדרות ← גישה ל-API. אין צורך להיכנס ל-Dashboard של Open Finance.

  • לקוחות פלטפורמת Open Finance: את המפתחות מוצאים ב-Dashboard באזור המפתחות והאימות.

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

⚠️ ה-clientSecret סודי — אל תחשוף אותו בצד הלקוח (frontend) או בקוד פומבי. שמור אותו בצד השרת בלבד.


הגבלת המפתח לקריאת מידע בלבד

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

  1. ב-Financy, היכנסו להגדרות ← גישה ל-API.

  2. הפעילו את המתג מידע בלבד.

כשהמתג פעיל, המפתח יכול רק לקרוא חשבונות, עסקאות וחיבורים. תשלומים, מחיקת חיבורים ואינטגרציות (כמו Invoice4U) חסומים — כולל קריאת החשבוניות מ-Invoice4U. כשהמתג כבוי (ברירת המחדל), למפתח יש את כל ההרשאות של התוכנית שלכם.

  • השינוי חל על טוקנים חדשים. טוקן שכבר הונפק ממשיך לפעול עד שיפוג. ה-CLI של Financy מבקש טוקן חדש אוטומטית כשצריך.

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

  • מקבלים שגיאת הרשאות (למשל INSUFFICIENT_SCOPE) על תשלום או על Invoice4U? בדקו אם המתג מידע בלבד פעיל, וכבו אותו אם המפתח צריך את הפעולות האלה.


2. מהו userId

כל משתמש קצה שאתה מחבר מיוצג על ידי userId ייחודי במערכת שלך. הטוקן וכל הנתונים הם per-user — הם שייכים ל-userId שעבורו הונפקו. אם חיברת דרך Financy, ה-userId הוא המייל שאיתו נרשמת.


3. הפק Access Token

שלח את ה-clientId, clientSecret ו-userId ל-token endpoint וקבל טוקן תקף. המדריך המלא: אימות מול ה-API – קבלת Access Token.


4. בצע את הקריאה הראשונה

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

מערכות עסקיות (חשבוניות, ERP ונתוני סליקה מישראכרט עסקים) זמינות ב-API רק עם מפתח ה-API של ארגון Financy, מהגדרות ← גישה ל-API ב-Financy. מפתחות של לקוחות פלטפורמת Open Finance מה-Dashboard לא ניגשים אליהן.

💡 החיבור לבנק עצמו מתבצע דרך Financy ולא דרך ה-API.


תיעוד מלא ופיצ'ר "Try It": docs.open-finance.ai.

האם קיבלת תשובה לשאלתך?