צירוף מסמך תומך

צירוף מסמך תומך המבוסס על תבנית

השתמשו בתבנית מתוך get_supporting_document_templates וברשומת זהות שכבר שייכת לחשבונכם. העלו את הקבצים שלה באמצעות create_encrypt_files תוך שימוש בשדה supporting_template_id. קבצים רגילים המועלים כהוכחת זהות או כתובת שייכים לקטגוריה אחרת ואי אפשר להשתמש בהם כתחליף.

יצירת המסמך התומך

השתמשו בחשבון API פעיל של MultiTEL ובכתובת ה-IP המורשית שלו. הדוגמאות משתמשות בפרטי הזדהות לאימות HTTP Basic מתוך משתני סביבה; פעלו לפי כללי האימות המתאימים לסוג החשבון שלכם. שלחו בקשות באמצעות HTTPS. בדקו הן את תגובת ה-HTTP והן את השדה הבא ב-JSON: status.code; שגיאות ברמת היישום עשויות להגיע עם HTTP 200. הדוגמאות שלהלן בדויות.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --header 'Content-Type: application/json' \
  --data @supporting-request.json \
  https://api.multitel.net/v3/create_supporting_document

{
  "identity_id": "33333333333333333333333333333333",
  "template_id": "55555555555555555555555555555555",
  "encrypted_file_ids": [
    "66666666666666666666666666666666"
  ]
}

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

המסמך התומך שנוצר

{
  "status": {
    "code": 200,
    "msg": "Supporting document created successfully."
  },
  "response": {
    "id": "77777777777777777777777777777777",
    "template_id": "55555555555555555555555555555555",
    "identity_id": "33333333333333333333333333333333",
    "template_name": "Example supporting template"
  }
}

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

שגיאות וניסיונות חוזרים

קוד API 500 מציין נתוני קלט חסרים, שגיאות של מפעיל התקשורת או תגובה לא תקינה ממנו. קוד 404 מציין רשומת זהות שאינה משויכת לחשבון, תבנית לא תקינה, העלאות חסרות, שפג תוקפן או ששייכות לקטגוריה שגויה, או קבוצת קבצים שמישה ריקה. בדקו את status.msg; HTTP 200 לבדו אינו מספיק.

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