תיעוד REST API
ממשקי REST API למספרי טלפון
גלו מדינות ומספרים זמינים, בדקו את ההצעה המלאה ונהלו את המספרים שבבעלותכם.
בחירת ה-API ופרטי ההזדהות יחד
חשבונות מאושרים מסוג מפתחים ואוטומציה, עסקי וספקי תקשורת יכולים לשלב שירותים שהופעלו. מפתח יחיד אינו צריך להתחזות לחברה. שליחת SMS/MMS מאפליקציה מחייבת את אישור השליחה והרישום הרלוונטיים. בשירותים ליחידים ולמשפחות אין API ללקוחות ליזום הודעות.
| משפחת API | כתובת בסיס (Base URL) | אימות ותוצאה |
|---|---|---|
| תקשורת v3 | https://api.multitel.net/v3 | פרטי הזדהות מאושרים מסוג Basic; אסימונים (tokens) שהוקצו ומתאימים לשימוש, רק בפעולות שתומכות בהם. JSON עם status ו-response. |
| רישום לשירותי חירום | https://api.multi.tel/emergency | פרטי הזדהות מאושרים מסוג Basic או גישת bearer שהוקצתה במיוחד. JSON עם code, message ו-data. |
| אינטגרציות REST של הפורטל | המארח והפעולה כפי שמוצגים בתיעוד המפתחים של החשבון שלך | יש להשתמש בפרטי ההזדהות, בהיקפי ההרשאה (scopes) ובסכמה המתועדים של אותה פעולה. בקשות מסשן דפדפן משתמשות בממשק נפרד. |
יש להגדיר את MULTITEL_API_USERNAME ואת MULTITEL_API_PASSWORD בהגדרות הסודות של השרת שלך לפני השימוש בדוגמאות. אין להטמיע אותם ב-JavaScript ציבורי בדפדפן, בכתובות URL או בבקרת גרסאות. פרטי הזדהות ייעודיים מנוהלים ב-הגדרות שילוב API.
קריאת קטלוג המדינות הזמין
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getcountries"תגובת v3 כוללת את status ומערך response. רשומות המדינות כוללות isocode, name, countrycode, מידע על יכולות ו-next_function. הזמינות תלויה בחשבון ובמלאי; הופעת מדינה אינה הבטחה שכל קידומת או סוג מספר נמצאים במלאי.
{
"status": {
"code": 200,
"msg": "Results: 1"
},
"response": [
{
"countrycode": "1",
"name": "United States",
"description": "United States",
"isocode": "US",
"is_mobile": 0,
"sms_coverage": 1,
"latitude": "37.0902",
"longitude": "-95.7129",
"next_function": "v3/getareas/US"
}
]
}מגילוי ועד הפעלה
- יש לבחור את המדינה, את תת-האזור היכן שנדרש, את האזור ואת סוג המספר באמצעות פעולות הגאוגרפיה המתאימות.
- יש לקרוא את מחירי ההקמה, החודשיים והשימוש של המספר שנבחר, את הערוצים, את המכסה ואת דרישות הרישום.
- יש להגיש את מסמכי משתמש הקצה הנדרשים ולעקוב אחר מצבם. מספר עשוי להישאר בהמתנה עד לאישור.
- יש לבצע הזמנה פעם אחת עם בחירת המלאי והמחיר המדויקת. אם התגובה אינה ודאית, יש לבדוק את המלאי שלך לפני שליחת הזמנה נוספת.
- יש להגדיר ניתוב קולי ומסירת הודעות בנפרד, ואז לבדוק את המסלול המלא המיועד.
טיפול בשגיאות ובניסיונות חוזרים
- כשל באימות או בהרשאה
- יש לבדוק שפרטי ההזדהות של ה-API פעילים, שהשירות מותר ושמגבלות כתובת ה-IP של המקור מתקיימות. עוגיית סשן בפורטל אינה פרטי הזדהות לאינטגרציה.
- קרדיט לא מספיק או אישור שלא התקיים
- יש לטפל ביתרת החשבון, באישור השליחה או בדרישת המסמכים לפני שחוזרים על הפעולה.
- אין תוצאה
- יש לטפל במלאי ריק או בשם מתקשר חסר כתוצאה רגילה. אין להניח שלמספר תקין מבחינה תחבירית יש את כל השירותים.
- פסק זמן ברשת או כשל בשירות
- בפעולות קריאה יש להשתמש בניסיונות חוזרים מוגבלים עם השהיה גדלה (backoff). ברכישה, בשליחה או ברישום, יש לבדוק תחילה את מצב הפעולה; ניסיון חוזר של בקשה שהתקבלה עלול לשכפל פעולה בחיוב.
התמיכה באידמפוטנטיות (idempotency) תלויה בכל משפחת API. ה-API לשירותי חירום תומך במפתחות לניסיון חוזר; אין זה הופך בקשות v3 שרירותיות לאידמפוטנטיות. יש לשמור חותמות זמן, מזהים שהוחזרו ותגובות לאחר הסרת פרטים רגישים לצורך פנייה לתמיכה.
המשיכו עם מדריך העזר של החשבון שלכם
מדריך העזר למשתמשים מחוברים מסנן את הפעולות לפי ההרשאות והשירותים המופעלים בחשבונכם. השתמשו במארח המדויק, בסוג פרטי ההזדהות, בשדות הבקשה ובסכמת התגובה המופיעים בו. הקונסולות יכולות לבצע פעולות בפועל, כולל רכישות ושליחת הודעות.