צירוף אסמכתה לזהות או לכתובת

צירוף אסמכתה לזהות או לכתובת

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

יש לשמור את identity_id ואת address_id שהתקבלו מ־create_document; ה־UUID של הפרופיל שונה. התאימות לצירוף אסמכתה לכתובת במועד מאוחר יותר עבור פרופילים חדשים עדיין נבחנת. אם הכתובת נדחית, יש לבדוק בפורטל או לפנות לתמיכה לפני ניסיון חוזר.

יצירת האסמכתה

יש להשתמש בחשבון 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 @proof-request.json \
  https://api.multitel.net/v3/create_proof

{
  "entity_type": "identities",
  "entity_id": "33333333333333333333333333333333",
  "proof_type_id": "11111111111111111111111111111111",
  "encrypted_file_ids": [
    "22222222222222222222222222222222"
  ]
}

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

שמירת מזהה האסמכתה

{
  "status": {
    "code": 200,
    "msg": "Proof created successfully."
  },
  "response": {
    "id": "44444444444444444444444444444444",
    "entity_type": "identities",
    "entity_id": "33333333333333333333333333333333",
    "proof_type_id": "11111111111111111111111111111111",
    "proof_type_name": "Example identity proof"
  }
}

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

שגיאות וקבצים שהועלו ותוקפם פג

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

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