עדכון פרופיל רישום

החלפת פרטי הפרופיל הניתנים לעריכה

עדכנו פרופיל רישום קיים השייך לחשבון באמצעות מזהה ה-UUID המקומי שלו מתוך create_document או documents. פעולה זו משנה נתונים בחשבון ואצל ספק התקשורת במעלה השרשרת. היא אינה משנה את סוג הזהות השמור Personal/Business ואינה בקשת PATCH לעדכון חלק מהשדות בלבד.

בקשת עדכון

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

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --header 'Content-Type: application/json' \
  --data @registration-profile-update.json \
  "https://api.multitel.net/v3/update_document/$DOCUMENT_UUID"

{
  "first_name": "Example",
  "last_name": "Person",
  "phone_number": "12025550123",
  "email": "end-user@example.com",
  "city": "Example City",
  "postal_code": "00000",
  "address": "1 Example Street",
  "country": "US",
  "nationality": "US",
  "signature": "BASE64_PNG_OF_THE_AUTHORIZED_END_USER_SIGNATURE",
  "id_number": "",
  "personal_tax_id": "",
  "birth_date": "",
  "description": "Example profile",
  "company_name": "",
  "company_reg_number": "",
  "incorporation_country": "",
  "vat_id": "",
  "address_description": ""
}

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

דרישות השדות לעדכון
שדות	התנהגות
first_name, last_name, city, postal_code, address	שדות חובה; עד 64 תווים בכל שדה.
phone_number	ערך מספרי חובה באורך שמונה תווים לפחות; השתמשו בספרות בפורמט בינלאומי, כולל קידומת המדינה.
signature	שדה חובה. הפורטל מספק בתים של PNG בקידוד Base64 ללא קידומת כתובת URL מסוג נתונים.
country	ספקו קוד ISO של מדינת הכתובת מתוך קטלוג הרישום. רכיב הטיפול מאתר את המדינה המתאימה לקוד, אף שעדכון הכתובת שנבדק אינו משנה את השיוך למדינה.
nationality	קוד ISO של מדינה הוא שדה חובה עבור פרופיל קיים מסוג Personal.
company_name, incorporation_country	שדות חובה עבור פרופיל קיים מסוג Business; שם החברה מוגבל ל-64 תווים, ויש לציין את מדינת ההתאגדות באמצעות קוד ISO.
email	כתובת דוא״ל תקינה שאינה חובה, באורך של עד 254 תווים. השמיטו את השדה כדי לשמר את כתובת הדוא״ל השמורה ליצירת קשר; שלחו ערך ריק כדי למחוק אותה מקומית.
id_number, personal_tax_id, birth_date, description, company_reg_number, vat_id	שלחו את הערכים העדכניים הרצויים. ערכים שהושמטו מקבלים כברירת מחדל ערך ריק ועלולים לדרוס ערכים קיימים שנשמרו.

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

מתקדם: הוספת אסמכתאות שהועלו מראש

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

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

תגובות הצלחה וכישלון בפורמט הישן

{
  "status": {
    "code": "success",
    "msg": "Successfully Saved."
  },
  "response": ""
}

קוד ההצלחה הרגיל של נקודת קצה זו הוא המחרוזת success, ולא המספר 200. כישלון רגיל אצל ספק התקשורת במעלה השרשרת או במערכת המקומית עשוי להשתמש במחרוזת error. הקוד המספרי 400 מציין שדות לא תקינים או כישלונות הקשורים לאסמכתאות, 404 מציין פרופיל חסר או הפניה לא תקינה לקובץ שהועלה, ו-500 מציין גוף בקשה ריק או מדינה שלא אותרה. קראו את ההודעה ואת כל רשומות האימות; אל תחשיבו תגובת HTTP 200 לבדה כהצלחה.

מגבלות העדכון הנוכחיות והתאוששות מכשל

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

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