מפתחים

GET/tcr/v2/brand/{brandId}/externalVetting

בדיקת תוצאות הבדיקה של מותג

עיינו בתוצאות הבדיקה של מותג בחשבונכם ועקבו אחר בדיקה קיימת דרך תוצאות ממתינות, מוצלחות או שנכשלו.

בעמוד זה
  1. בחרו את המותג שברצונכם לבדוק
  2. עקבו אחר בדיקה קיימת
  3. הבינו את החיובים בגין הזמנה קודמת
  4. נסו לבצע את הקריאה שוב בלי להגיש הזמנה נוספת
  5. שמרו על הפרדה בין שלבי הרישום
  6. בקשה
  7. תשובה
  8. שגיאות
  9. זמינות והשפעות נלוות

בחרו את המותג שברצונכם לבדוק

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

עקבו אחר בדיקה קיימת

שמרו את vettingId, evpId, vettingClass ואת vettingStatus כאשר הם קיימים. מנגנון הסנכרון הנוכחי מתייחס אל PENDING ואל UNSCORE כתוצאות שעדיין ממתינות לבדיקה נוספת, ואל ACTIVE ואל FAILED כתוצאות סופיות לצורך הסדרת החיוב. קראו את הפרטים שהוחזרו לפני שתחליטו אם נדרשת פעולת המשך. רשימה ריקה כשלעצמה אינה הוכחה לכך שהגשה קודמת לא הגיעה למרשם.

הבינו את החיובים בגין הזמנה קודמת

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

נסו לבצע את הקריאה שוב בלי להגיש הזמנה נוספת

במקרה של כשל זמני, שמרו את מזהה המותג ואת מזהי הבדיקה הידועים, פעלו בהתאם ל־Retry-After ונסו לבצע את הקריאה שוב תוך הגדלת מרווחי ההמתנה בין ניסיונות. אין להגיש הזמנת בדיקה חדשה רק משום שאחזור הסטטוס נכשל או החזיר גוף תשובה בלתי צפוי. אם אי ההתאמה נמשכת, פנו אל MultiTEL בערוץ תמיכה מאומת וציינו את מזהי האסמכתה הרלוונטיים.

שמרו על הפרדה בין שלבי הרישום

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

בקשה

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

בצעו GET עם מזהה המותג בנתיב ועם מסנן השאילתה הנדרש vettingStatus. הסכמה שנבדקה מגדירה מערך של סטטוסים; דוגמה זו מבקשת ערך ACTIVE אחד. מדריך זה אינו מבסס כיצד לקודד ערכים מרובים או שהספק מקבל בקשות ללא סינון. אין צורך בגוף בקשה.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/brand/$BRAND_ID/externalVetting?vettingStatus=ACTIVE"
פרמטרים בנתיב
שםסוגחובהתיאור
brandIdמחרוזתכןמזהה המותג במרשם המשויך לחשבון MultiTEL שלכם. זה אינו מזהה החשבון שלכם או מזהה בדיקה.
פרמטרים בשאילתה
שםסוגחובהתיאור
vettingStatusמערך מחרוזותכןמסנן סטטוס נדרש. ערכים מותרים: PENDING, UNSCORE, ACTIVE, FAILED, EXPIRED. הדוגמה מספקת ערך ACTIVE אחד; אין כאן טענה לגבי קידוד של ערכים מרובים או קבלת בקשות ללא סינון על ידי הספק.

תשובה

הנתיב הנוכחי משמר את סטטוס HTTP ואת גוף התשובה של המרשם במקום להשתמש במעטפת התשובה הישנה של v3. המערך הבדיוני המקוצר ממחיש שדות המשמשים בתהליך הסנכרון המקומי; הוא אינו תשובה שנלכדה מהמרשם או סכמה שמובטח שהיא מלאה. בדקו את סטטוס HTTP ואת JSON לפני קריאת הרשומות. שמרו כל vettingId לצד המותג שנבחר.

מבנה תשובה להמחשה; אלה אינם נתוני חשבון בזמן אמת או הצעת מחיר עדכנית.

[
  {
    "vettingId": "example-vetting-id",
    "evpId": "example-review-provider",
    "vettingClass": "STANDARD",
    "vettingStatus": "ACTIVE"
  }
]

שגיאות

  • 401: אימות החשבון נכשל. בדקו את פרטי ההזדהות, את מצב ההפעלה של API ואת ההגבלות החלות על כתובת ה־IP של המקור.
  • 404: המותג אינו משויך לחשבון זה, או שהמרשם לא הצליח למצוא אותו. דחייה עקב אי התאמה בבעלות החשבון מתרחשת לפני שליחת הבקשה למרשם.
  • 429: הגעתם למגבלת הבקשות של החשבון או של המרשם. פעלו בהתאם ל־Retry-After והגדילו את מרווחי ההמתנה בין ניסיונות.
  • 502/503: התעבורה, המרשם, מנגנון הגבלת הבקשות או העיבוד המקומי אינם זמינים. שגיאה אינה מוכיחה שבקשת בדיקה קודמת נכשלה.

זמינות והשפעות נלוות

  • בקשת GET זו אינה יוצרת הזמנת בדיקה חדשה. היא מאחזרת תוצאות מהמרשם, כותבת רשומות ביקורת של בקשות ומסנכרנת תוצאות שמורות.
  • קריאת תוצאה שהושלמה עשויה להסדיר את החיוב בגין הזמנת בדיקה הכרוכה בתשלום שבוצעה בעבר. בדיקה שנכשלה עשויה להיות כרוכה בחיוב בגין כישלון, אם הוא חל. עיינו במחיר ובתנאים בעת ההזמנה; קריאה זו אינה הצעת מחיר.
  • רשומה שהתגלתה זה עתה ויובאה באמצעות בקשת GET זו אינה מסווגת אוטומטית כהזמנה חדשה הכרוכה בתשלום.
  • תוצאת בדיקה מוצלחת או בסטטוס ACTIVE אינה מהווה אישור קמפיין, הקצאת מספר טלפון או הרשאה לשלוח הודעות.