מיקרופיי · מרכז מפתחים מרכז מפתחים · סקירה כללית

מרכז המפתחים של מיקרופיי

עודכן לאחרונה: 9 ביוני 2026

ה-API של מיקרופיי מאפשר לשלוח סמס, הודעות קוליות, הודעות וואטסאפ וקודי OTP, לנהל אנשי קשר ותתי מנהלים, ולקבל חיוויי מסירה והודעות נכנסות, ישירות ממערכות מחשוב, מערכות CRM, אתרים ואפליקציות. כל הממשקים פועלים ב-HTTPS סטנדרטי, נתמכים ב-HTTP GET, POST ו-JSON, ומאומתים באמצעות טוקן.

בסיס הכתובות
/extApi/
פרוטוקול
HTTPS · GET · POST · JSON
אימות
טוקן בפרמטר token
פורמט תשובה
טקסט או JSON אחיד

Quickstart: הקריאה הראשונה תוך דקות

1 צרו טוקן: במערכת מיקרופיי, בתפריט הראשי בחרו ב"ניהול חשבון ותתי מנהלים" ולאחר מכן ב"טוקנים לממשקים", וצרו טוקן עם ההרשאות המתאימות לממשק (לדוגמה שירותי סמס). ראו אימות וטוקנים.
2 בצעו את הקריאה הראשונה: הוסיפו את הטוקן בפרמטר token וקראו לממשק. לדוגמה, שליחת סמס:
בסיסי · HTTP GET 
curl "https://www.micropay.co.il/extApi/scheduleSms.php?get=1&token=XXXXX&from=035555555&msg=test%20message&list=0501234567"
אותה קריאה · JSON 
curl -X POST https://www.micropay.co.il/extApi/scheduleSms.php \
  -H "Content-Type: application/json" \
  -d '{"token":"XXXXX","from":"035555555","msg":"test message","list":"0501234567"}'
3 קראו את התשובה: בשליחה רגילה מתקבל טקסט שמתחיל ב-OK ואחריו קוד הקמפיין; במצב JSON מתקבל מבנה אחיד.
Plain text 
OK 34556
JSON 
{"status":1,"message":"OK","data":{"taskId":"34556","remoteIP":"203.0.113.10"}}
רוצים להבין את כל המוסכמות (GET/POST מול JSON, מבנה התשובה, קידוד ושגיאות)? ראו מוסכמות ופורמט תשובה.

ממשקי ה-API

בחרו את הממשק שמתאים לכם. לכל ממשק עמוד ייעודי עם כל הפרמטרים ודוגמאות ב-cURL.

שליחת סמס
שליחת הודעות סמס לרשימות מספרים או רשימות תפוצה, עם תזמון והתראות.
שליחת וואטסאפ
שליחת הודעות וואטסאפ בתבניות מאושרות, עם פרמטרים לתבנית ופרמטרים אישיים לכל נמען.
הודעות קוליות
שליחת הודעות קוליות (VMS) ללקוחות לרשימות מספרים או תפוצה.
OTP וקוד אימות
שליחה ואימות של קוד חד-פעמי בסמס או בהודעה קולית, לאימות דו-שלבי.
אימות זיהוי שולח
בקשה ואימות של זיהוי שולח (sender ID) חדש לשליחה.
ניהול אנשי קשר
הוספה, מחיקה ובדיקה של אנשי קשר ברשימות תפוצה.
ניהול תתי מנהלים
ניהול יתרות סמס והודעות קוליות עבור תתי מנהלים.
סטטוס קמפיין
בדיקת סטטוס השליחה של קמפיין לפי קוד הקמפיין.
יתרת סמס
בדיקת יתרת הודעות הסמס בחשבון.
מחיקת קמפיין
מחיקת קמפיין מתוזמן לפני מועד השליחה.
מייל לסמס
שליחת הודעת סמס באמצעות שליחת דואר אלקטרוני.

Webhooks: התראות לשרת שלך

הממשקים הבאים שולחים נתונים מהמערכת אל השרת שלך, בשיטת GET או ב-JSON (לפי בחירתכם).

סטטוס מסירה (DLR)
קבלת חיווי מסירה לכל הודעה שנשלחה, ישירות לעמוד בשרת שלך.
סמס נכנס
קבלת הודעות סמס נכנסות מהלקוחות לעמוד בשרת שלך.
מידע דינמי IVR
מענה דינמי בזמן שיחה: השרת שלך מחזיר את ההמשך למערכת המענה הקולי.

אינטגרציות

Zapier
חיבור מיקרופיי לאלפי אפליקציות דרך זאפייר, ללא כתיבת קוד.

צעדים ראשונים

אימות וטוקנים
יצירת טוקן, הרשאות, ושימוש בטוקן בפניות.
מוסכמות ופורמט תשובה
GET/POST מול JSON, מבנה התשובה, קידוד ושגיאות.
מילון מונחים
הסבר קצר למונחים: OTP, 2FA, webhook, DLR ועוד.

שאלות נפוצות

איך מתחילים לעבוד עם ה-API של מיקרופיי?

יוצרים טוקן במערכת (בתפריט "ניהול חשבון ותתי מנהלים" ואז "טוקנים לממשקים") עם ההרשאות המתאימות, מוסיפים אותו בפרמטר token לכתובת הממשק, ומבצעים קריאת HTTPS ב-GET, POST או JSON. ראו את ה-Quickstart למעלה.

באילו פורמטים אפשר לשלוח ולקבל נתונים?

כל הממשקים תומכים בשליחה רגילה ב-name=value (GET או POST) המחזירה טקסט, ובמצב JSON אופציונלי המחזיר מבנה אחיד {status, message, data}. ראו מוסכמות ופורמט תשובה.

אילו ממשקים זמינים?

שליחת סמס, הודעות קוליות, OTP, אימות זיהוי שולח, ניהול אנשי קשר, ניהול תתי מנהלים, סטטוס קמפיין, יתרת סמס, מחיקת קמפיין ומייל לסמס, וכן שלושה Webhooks (סטטוס מסירה, סמס נכנס, מידע דינמי IVR) וחיבור בזאפייר.

רוצים להתחיל?
פתחו חשבון, צרו טוקן והריצו את הקריאה הראשונה תוך דקות
פתחו חשבון חינם