מפתחים

GET/v3/get_proof_types

הצגת קטגוריות אסמכתאות

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

בעמוד זה
  1. בחרו קטגוריית אסמכתאות
  2. התאימו את האסמכתאות לדרישות בפועל
  3. בקשה
  4. תגובה
  5. שגיאות
  6. זמינות והשפעות נלוות

בחרו קטגוריית אסמכתאות

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

התאימו את האסמכתאות לדרישות בפועל

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

בקשה

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

GET עם כל פרמטר מתועד בנתיב כתובת ה-URL.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_proof_types"

תגובה

בדקו את status.code בגוף ה-JSON וגם את סטטוס ה-HTTP. response הוא מערך של אובייקטים הכוללים את id, name ו-entity_type. ערכים אלה מגיעים מקטלוג האסמכתאות הנוכחי. המזהים הם ערכים אטומים; העתיקו אותם במקום להרכיב מזהה או ליצור אותו באמצעות גיבוב. ניתן להחזיר קטלוג ריק בהצלחה. אל תקבעו בקוד רשימה ממצה של סוגי ישויות על סמך דוגמה זו.

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

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "id": "PROOF_TYPE_ID_FROM_RESPONSE",
      "name": "Example proof category",
      "entity_type": "ENTITY_TYPE_FROM_RESPONSE"
    }
  ]
}

שגיאות

  • בדקו את status.code ואת status.msg לזיהוי שגיאות אימות או שירות. קבלת קטלוג ריק בהצלחה אינה מהווה אישור למסמך או פטור מרישום.

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

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