פרמטרים בדף תשלום (iframe)
\nבאמצעות המערכת החכמה של הגדרת דפי תשלום ניתן להגדיר לכל פרויקט דפי תשלום מותאמים אישית.
\nיש שתי אפשרויות להגדיר את הפרמטרים, או בהגדרת דף תשלום, או שליחת הפרמטרים ב url או ב Post.
\nמה ההבדל בין הגדרות דף תשלום לבין שליחת פרמטרים ?
\nהגדרות דף תשלום משפיעות על הדף כולו, ניתן להגדיר איזה שדות להציג ואיזה שדות לחייב ואיזה שדות לאפשר לשנות ומה יהיה ברירת המחדל של כל שדה. - הקישור הישיר לדף התשלום יושפע מהגדרות הדף.
\nשליחת פרמטרים ב URL משפיעה רק על הדף המוצג למשתמש באותו רגע. - בצורה הזו ניתן לעשות כל מיני דברים לא קבועים, לדוגמא: שהמשלם יראה את השם שלו, סכום מותאם למשלם מסוים, וכדומה.
\nהגדרות דף תשלום
\nמתבטא באתר בכרטיסיית 'פרויקטים ודפי תשלום'
\nהגדרת פרמטרים לשליחה ב get או ב post
\nשליחת פרמטרים בget מתאימה לכל אחד
\nמוסיפים בסוף הקישור הרגיל של דף התשלום את הפרמטר הרצוי.
\nלדוגמא: קישור רגיל: https://ultra.kesherhk.info/external/paymentPage/310531
\nדוגמא נוספת: קישור עם פרמטרים מותאמים אישית: (סכום הגביה יהיה 80 ש\"ח ומספר התשלומים הוא 3)
\nhttps://ultra.kesherhk.info/external/paymentPage/310531?total=80&numpayment=3
\nבקשת Post:
\nמתאים למפתחים
\naction=\"ultra.kesherhk.info/external/paymentPage/310423\" target=\"_top\">
\nvalue=\"2\"/>
\nלאחר ביצוע עסקה אפשר להגדיר שהמערכת תבצע פעולות באופן אוטומטי
\n1. נתיב לחזרה בהצלחה/כישלון
\nאחרי ביצוע עסקה, המערכת מפנה את המשלם לעמוד תודה/טקסט מותאם אישית/כתובת אינטרנט לפי ההגדרה שבחרת.
\n2. נתיב פעולה בהצלחה/כישלון
\nאחרי ביצוע עסקה המערכת תשלח עדכון מאחורי הקלעים למערכת שלכם על מנת שתוכלו לבצע פעולות נוספות (רישום מסודר על העסקאות,העברת מידע ל CRM, סגירת מסמכים ב e commerce וכדומה)
\nפרמטרים החוזרים למשתמש בנתיב חזרה להצלחה / לכישלון
\nבמידה והוגדרה כתובת למעבר אחרי ביצוע עסקה ישורשרו לה הפרמטרים הבאים:
\nפרמטרים לנתיב לחזרה בהצלחה:
\n- \n
- ref - מספר אישור \n
- total - סכום \n
- currency - מטבע \n
- adddata - טקסט חופשי (במידה ונשלח) \n
- transactionNumber - מספר עסקה \n
- obligationRef - אסמכתת הו\"ק \n
- receiptLink - קישור להורדת קבלה לעסקה \n
- docNumber - מספר הקבלה שהונפקה \n
רק אם הוראת קבע היא ללא הגבלה ומספר התשלומים יהיה מלא unlimited והסכום יהיה חודשי
\n- \n
- numPayment -(ללא הגבלה) \"unlimited\" \n
פרמטרים לנתיב לחזרה בעת כישלון:
\n- \n
- errorCode - קוד שגיאה \n
- errorText- תיאור השגיאה \n
- adddata - טקסט חופשי (במידה ונשלח) \n
- transactionNumber - מספר עסקה \n
בנתיב פעולה בהצלחה / כישלון
\nאם מוגדר שליחת פרמטרים ישלחו הפרמטרים כפי שחוזר בנתיב לחזרה + פרמטר בוליאני isSucces
\nוכן בפרמטר adddata יחזור הערך שנשלח בaddactiondata
\nשים לב💗:
\nאם לא מוגדר לשלח פרמטרים ישלח לניתוב זה רק בעת הצלחה
\nוהנתונים שישלחו בaddactiondata ישלחו בהמשך ישיר לניתוב אם הניתוב מכיל את הפרמטר '?'
\nאחרת ישלח \"=adddata?\"
\nעמוד ליצירת טוקן
\nעמוד זה אינו מיועד להעברת עסקאות אלא ליצירת טוקן שיאפשר לסלוק באמצעותו בהמשך.
\nבעמוד מוצגים השדות של מס' אשראי ותוקף בלבד
\nע\"מ לעבוד עם עמוד זה יש לשים לב לנקודות הבאות
\n- \n
- יש להגדיר את העמוד כעמוד מסוג טוקן \n
- חובה למלא נתיב אליו ישלח הטוקן לאחר שיווצר בהגדרות הדף בפעולות לאחר שליחה בנתיב לקבלת טוקן . \n
- חובה לשלוח את הפרמטר customerRef - מזהה לקוח שלכם, ע\"מ שתוכלו לקשר בין הלקוח לבין הטוקן. \n
- הקריאה תתבצע בPOST \n
שינוי אמצעי תשלום להתחייבות
\nהמערכת מאפשרת לשנות אמצעי תשלום להתחייבויות בAPI.
\nשם הפונקציה:ChangeChargeOptionForObligation
\nהקוד ששולחים הוא:
\nkesherhk.info/KesherAPI/ChangeChargeOptionForObligation
\nטוקן - יש לבקש את הטוקן משירות הלקוחות שלנו ולמלא ב authorization header של הבקשה מסוג Bearer token
\nפרמטרים -הפונקציה מקבלת אסמכתת הוק, מייל מפתח ואובייקט המכיל את פרטי האמצעי תשלום החדש.
\nיש אפשרות לשנות לסוג אמצעי תשלום הזהה לסוג שקיים להתחייבות(אמצעי התשלום הישן מתבטל).
\n","urlObject":{"protocol":"https","path":["KesherAPI","ChangeChargeOptionForObligation"],"host":["kesherhk","info"],"query":[],"variable":[]}},"response":[{"id":"28fedf79-9d54-4012-b610-c1c04a3272fa","name":"ChangeChargeOptionForObligation","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"obligationReference\": \"XXXXXXX\",\r\n \"CompanyDeveloperMail\":\"XXXXX\",\r\n \"addChargeOptionRequest\": {\r\n \"entity\": {\r\n \"name\": \"TEST\",\r\n \"tz\": null,\r\n \"accountOrToken\": \"XXXXXXXX\",\r\n \"expiryOrBranch\": \"XXXX\",\r\n \"bank\": null,\r\n \"type\": 1,\r\n \"limitSum\": null,\r\n \"limitDate\": null,\r\n \"hasBankAuth\": 0\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://kesherhk.info/KesherAPI/ChangeChargeOptionForObligation"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Succeeded\": true,\n \"Code\": 944,\n \"Message\": \"פעולה בוצעה בהצלחה\"\n}"}],"_postman_id":"18c8975b-ef25-4dcb-9a8f-acc4363326bb"}],"id":"3d65e754-5cd6-4de4-a176-fa76241c8d60","_postman_id":"3d65e754-5cd6-4de4-a176-fa76241c8d60","description":""},{"name":"CreateCompany","id":"239b7f33-f15e-41d2-aae3-92e13694775f","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"הקמת חברה חדשה
\nהמערכת מאפשרת להקים חברות בAPI.
\nלהצטרפות לשירות יש לבקש משירות הלקוחות להגדיר את האפשרות הזו בהגדרות של החברה הראשית שלך.
\nשם הפונקציה: CreateCompany
\nהקוד ששולחים הוא:
\nkesherhk.info/KesherAPI/CreateCompany
\nטוקן - יש לבקש את הטוקן משירות הלקוחות שלנו ולמלא ב authorization header של הבקשה מסוג Bearer token
\nפרמטרים - הפונקציה מקבלת אובייקט המכיל את פרטי החברה החדשה
\n![](\"https://lh7-rt.googleusercontent.com/docsz/AD_4nXf1rrbPi1gj0YUmVXt1Lo17rBK7ep-kSpuXQlrMkybl6XD6KfAb1M3TduHwlpJIR2PnrPN0m9liviwJAEo2uxkxBvC_ngDP0GrSCoZ1QUMWaF5KA0b2fYW0___aHarMb4mgXPE34aeWG6gQ8MvGfs01Ns_S?key=DJfzprG993VDyiqLMcTgIA\")
\n\nפירוט פרמטרים אובייקט אמצעי תשלום - chargeOption :
\nערך מוחזר: הפונקציה מחזירה אוביקט המכיל את סטטוס הצלחה/כישלון, תיאור סטטוס, מספר לקוח בקשר וAPIKey עבור החברה החדשה
\nפירוט מבנה האוביקט
\nלאחר ביצוע עסקה אפשר להגדיר שהמערכת תבצע פעולות באופן אוטומטי
\n1. נתיב לחזרה בהצלחה/כישלון
\nאחרי ביצוע עסקה, המערכת מפנה את המשלם לעמוד תודה/טקסט מותאם אישית/כתובת אינטרנט לפי ההגדרה שבחרת.
\n2. נתיב פעולה בהצלחה/כישלון
\nאחרי ביצוע עסקה המערכת תשלח עדכון מאחורי הקלעים למערכת שלכם על מנת שתוכלו לבצע פעולות נוספות (רישום מסודר על העסקאות,העברת מידע ל CRM, סגירת מסמכים ב e commerce וכדומה)
\nפרמטרים החוזרים למשתמש בנתיב חזרה להצלחה / לכישלון
\nבמידה והוגדרה כתובת למעבר אחרי ביצוע עסקה ישורשרו לה הפרמטרים הבאים:
\nפרמטרים לנתיב לחזרה בהצלחה:
\n- \n
ref - מספר אישור
\n \ntotal - סכום
\n \ncurrency - מטבע
\n \nadddata - טקסט חופשי (במידה ונשלח)
\n \ntransactionNumber - מספר עסקה
\n \nobligationRef - אסמכתת הו\"ק
\n \nreceiptLink - קישור להורדת קבלה לעסקה
\n \ndocNumber - מספר הקבלה שהונפקה
\n \n
רק אם הוראת קבע היא ללא הגבלה ומספר התשלומים יהיה מלא unlimited והסכום יהיה חודשי
\n- \n
- numPayment -(ללא הגבלה) \"unlimited\" \n
פרמטרים לנתיב לחזרה בעת כישלון:
\n- \n
errorCode - קוד שגיאה
\n \nerrorText- תיאור השגיאה
\n \nadddata - טקסט חופשי (במידה ונשלח)
\n \ntransactionNumber - מספר עסקה
\n \n
בנתיב פעולה בהצלחה / כישלון
\nאם מוגדר שליחת פרמטרים ישלחו הפרמטרים כפי שחוזר בנתיב לחזרה + פרמטר בוליאני isSucces
\nוכן בפרמטר adddata יחזור הערך שנשלח בaddactiondata
\nשים לב💗:
\nאם לא מוגדר לשלח פרמטרים ישלח לניתוב זה רק בעת הצלחה
\nוהנתונים שישלחו בaddactiondata ישלחו בהמשך ישיר לניתוב אם הניתוב מכיל את הפרמטר '?'
\nאחרת ישלח \"=adddata?\"
\nעמוד ליצירת טוקן
\nעמוד זה אינו מיועד להעברת עסקאות אלא ליצירת טוקן שיאפשר לסלוק באמצעותו בהמשך.
\nבעמוד מוצגים השדות של מס' אשראי ותוקף בלבד
\nע\"מ לעבוד עם עמוד זה יש לשים לב לנקודות הבאות
\n- \n
יש להגדיר את העמוד כעמוד מסוג טוקן
\n \nחובה למלא נתיב אליו ישלח הטוקן לאחר שיווצר בהגדרות הדף בפעולות לאחר שליחה בנתיב לקבלת טוקן .
\n \nחובה לשלוח את הפרמטר customerRef - מזהה לקוח שלכם, ע\"מ שתוכלו לקשר בין הלקוח לבין הטוקן.
\n
הקריאה תתבצע בPOST \n
המערכת מאפשרת להצטרף לשירות הפקת מסמכים בחברת איזיקאונט בAPI.
\nשם הפונקציה: ConnectToEZCountService
\nהקוד ששולחים הוא:
\nhttps://kesherhk.info/KesherAPI/ConnectToEZCountService
\nמבנה הקוד:
\nשולחים את כתובת ה URL שמכיל בתוכו את הנתונים הבאים:
\nטוקן - יש לבקש את הטוקן משירות הלקוחות שלנו ולמלא ב authorization header של הבקשה מסוג Bearer token.
\nערך מוחזר: הפונקציה מחזירה אוביקט המכיל את סטטוס הצלחה/כישלון, תיאור סטטוס.
\nמבנה האובייקט המוחזר:
\n","urlObject":{"protocol":"https","path":["KesherAPI","ConnectToEZCountService"],"host":["kesherhk","info"],"query":[],"variable":[]}},"response":[],"_postman_id":"826e9faa-4d1a-42f1-8cf7-113aebbd73ef"},{"name":"sms טלפוני","id":"6bbdab59-e07a-4db3-aa8d-44ea02d7251b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"kesherhk.info/KesherAPI/SendCall?token=XXX&toPhone=XXX&code=XXXX","urlObject":{"path":["KesherAPI","SendCall"],"host":["kesherhk","info"],"query":[{"key":"token","value":"XXX"},{"key":"toPhone","value":"XXX"},{"key":"code","value":"XXXX"}],"variable":[]}},"response":[],"_postman_id":"6bbdab59-e07a-4db3-aa8d-44ea02d7251b"}],"id":"e67c7907-54d2-43c1-b663-b009f864927e","_postman_id":"e67c7907-54d2-43c1-b663-b009f864927e","description":""},{"name":"GetErrorValue","id":"9951bc17-36c2-49af-af7e-9f4ceb3692cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n \"Json\":{\r\n \"userName\": \"xxxxxxxxxx\",\r\n \"password\": \"xyxyxyxxyxyxxyyx\",\r\n \"func\": \"GetErrorValue\",\r\n \"Code\": \"000\"\r\n },\r\n \"format\": \"json\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://kesherhk.info/ConnectToKesher/ConnectToKesher","description":"קבלת סטטוסים
\nפירוט הסטטוסים :
\n","urlObject":{"protocol":"https","path":["ConnectToKesher","ConnectToKesher"],"host":["kesherhk","info"],"query":[],"variable":[]}},"response":[{"id":"849a392d-fb15-44f2-bba0-906fa62423be","name":"GetErrorValue","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n \"Json\":{\r\n \"userName\": \"xxxxxxxxxx\",\r\n \"password\": \"xyxyxyxyxyxxyxyxxy\",\r\n \"func\": \"GetErrorValue\",\r\n \"Code\": \"000\"\r\n },\r\n \"format\": \"json\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://kesherhk.info/ConnectToKesher/ConnectToKesher"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 12 Aug 2024 09:50:10 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"32"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"ETag","value":"W/\"20-Wy74VWnYVvd+0aAkq0T/DOViDRg\""},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=BuBLKggF1e36a7fAFpyE12hQdFitbGbxojpeZ%2BHuAAc4v6wcxJGFNeuzbXCOk6eUNkQ1Oaje6cCT5ruCINpe0YrLLRVj74hSiOmeFhdhRyxnaTYjtg1aUC9fSBq3Bww%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8b1f8f421e193b3e-IAD"}],"cookie":[],"responseTime":null,"body":"\"עסקה עברה בהצלחה\""}],"_postman_id":"9951bc17-36c2-49af-af7e-9f4ceb3692cd"}]}