אימות וטוקנים

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

יצירת טוקן

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

הרשאות הטוקן

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

שימוש בטוקן בפנייה

בכל פנייה לממשק יש לשלוח את הטוקן בפרמטר token, בשיטת GET, POST או בגוף ה-JSON:

curl "https://www.micropay.co.il/extApi/scheduleSms.php?get=1&token=XXXXX&from=035555555&msg=test&list=0501234567"

curl -X POST https://www.micropay.co.il/extApi/scheduleSms.php \
  -H "Content-Type: application/json" \
  -d '{"token":"XXXXX","from":"035555555","msg":"test","list":"0501234567"}'

אם הטוקן חסר, שגוי, או חסרה לו ההרשאה הנדרשת לממשק, המערכת תחזיר ERROR עם תיאור השגיאה (ב-JSON: status 0 ותיאור ב-data.description). ראו מוסכמות ופורמט תשובה.

טוקנים לתת מנהלים

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

שאלות נפוצות

המשך