עיון בקטלוג התבניות
השמיטו את מקטע ה־ISO האופציונלי מהנתיב כדי להציג את רשימת התבניות שהשירות מחזיר. ספקו קוד מדינה בתקן ISO כדי לסנן את הרשימה. הסינון מתבצע לפי הרמז למדינה שבתבנית, שעשוי להיות מוסק משם ועשוי להיות ריק.
בחירת תבנית לפי הדרישות
עצם הופעתה של תבנית אינו מעיד שהיא נדרשת או מתקבלת עבור כל מספר באותה מדינה. התאימו את מזהה התבנית לדרישות החלות על המסמכים התומכים. רשימה זו אינה יוצרת מסמך שמולא, חותמת עליו, מעלה אותו או מאשרת אותו.
אם לא מוחזרות תבניות
רשימה מסוננת ריקה עשויה להעיד שלא נמצא רמז תואם למדינה. רשימה ריקה ללא סינון עשויה גם לנבוע מכך שנתונים ממקור הנתונים במעלה הזרם אינם זמינים. אין לראות באף אחת מהתוצאות הוכחה לכך שלא נדרש מסמך תומך.
בדיקת עותק שהורד לפני השימוש בו
קישור להורדה מהקטלוג עשוי להחזיר עותק הכולל שינויי עיצוב או מיתוג. אין להניח שזהו הסכם מקורי שלא שונה, או שהורדתו ממלאת דרישת רישום. בדקו את התוכן לפני מילוי מסמך כלשהו או חתימה עליו.
כאשר אשף המסמכים בפורטל מציע הכנת הסכם, השתמשו בתצוגה המקדימה שלו ובתהליך ההגשה המפורש שלו. לגבי טפסים נדרשים אחרים, ודאו מול MultiTEL מהו הטופס העדכני לפני מילויו. תבנית שהורדה אינה קובץ מצורף חתום, אסמכתה שהועלתה או אישור למספר.
בקשה
השתמשו בפרטי ההזדהות של חשבון ה־API הפעיל שלכם דרך HTTPS. קיימת תמיכה באימות Basic ובאסימוני bearer פעילים של חשבון API; מגבלות החשבון חלות.
GET עם כל פרמטר מתועד בנתיב כתובת ה־URL.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/v3/get_supporting_document_templates/$COUNTRY_ISO"| שם | סוג | חובה | תיאור |
|---|---|---|---|
iso | string | לא | מסנן אופציונלי לפי קוד מדינה בתקן ISO. השמיטו מקטע נתיב זה במלואו לקבלת הרשימה ללא סינון. ההשוואה אינה מבחינה בין אותיות גדולות לקטנות. ערכים לא מוכרים או ללא התאמה מחזירים רשימה ריקה במקום שגיאה מפורשת על מדינה לא תקינה. |
תגובה
בדקו את status.code בגוף ה־JSON וגם את סטטוס ה־HTTP. response הוא מערך של אובייקטים הכוללים id, name, permanent, iso ו־url. permanent הוא מסוג boolean; iso עשוי להיות ריק וייתכן שהוסק משם התבנית. התייחסו למידע על המדינה כרמז, ולא כהחלטה בדבר זכאות. קטלוג ריק הוא תגובה מוצלחת בקוד 200, והוא עשוי להתקבל גם כאשר החיפוש במקור הנתונים במעלה הזרם אינו מניב נתונים. כתובת ה־URL נוצרת על ידי השירות; שם המארח שלה עשוי להיות שונה מזה שבדוגמה להמחשה.
מבנה תגובה להמחשה בלבד; אין מדובר בנתוני חשבון בזמן אמת או בהצעת מחיר עדכנית.
{
"status": {
"code": 200,
"msg": "",
"results": 1
},
"response": [
{
"id": "TEMPLATE_ID_FROM_RESPONSE",
"name": "Example supporting-document template",
"permanent": false,
"iso": "US",
"url": "https://api.multitel.net/v3/supporting_document/TEMPLATE_ID_FROM_RESPONSE"
}
]
}שגיאות
- בדקו את status.code ואת status.msg לאיתור שגיאות אימות או שירות. קטלוג ריק שהוחזר בהצלחה אינו אישור למסמך או פטור מרישום.
זמינות והשפעות נלוות
- חיפוש זה בקטלוג או בדרישות אינו יוצר זהות, מעלה אסמכתה, רושם מספר או מבצע הזמנה.
- תגובה מוצלחת של הקטלוג אינה אישור למסמכים שלכם או אישור לכך שניתן להפעיל מספר שנבחר.