إرفاق مستند داعم

إرفاق مستند داعم يستند إلى قالب

استخدم قالبًا من 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"
  ]
}

حقول الطلب
الحقل	المعنى
`identity_id`	معرّف الهوية المرتبطة بحسابك، وهو مطلوب. يربط هذا الطلب المستند بهوية، وليس مباشرةً بعنوان أو رقم هاتف.
`template_id`	معرّف قالب المستند الداعم، وهو مطلوب؛ استخدم القالب نفسه الذي اخترته لرفع الملفات الداعمة. حقل الإرفاق هو template_id، بينما حقل الرفع هو supporting_template_id.
`encrypted_file_ids`	مصفوفة JSON مطلوبة وغير فارغة تحتوي على المعرّفات المُعادة لعمليات الرفع. يجب أن يتبع كل منها الحساب الحالي، وأن تكون صلاحيته سارية، وأن يندرج ضمن فئة supporting_documents.

تُقبل أيضًا بيانات النماذج التي تتضمن تكرار الحقل 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"
  }
}

يؤكد ذلك إنشاء المستند الداعم، ولا يعني الموافقة التنظيمية أو تفعيل الرقم. ولا يشكّل مصطلح «دائم» الوارد في المورد لدى الجهة المنبع ضمانًا مقدّمًا للعميل بشأن مدة التخزين أو سياسة الحذف.

الأخطاء وإعادة المحاولة

يشير الرمز 500 في API إلى مدخلات مفقودة أو أخطاء لدى مشغّل الاتصالات أو استجابة غير صالحة منه. ويشير الرمز 404 إلى هوية غير مرتبطة بالحساب، أو قالب غير صالح، أو ملفات مرفوعة مفقودة أو منتهية الصلاحية أو من فئة غير صحيحة، أو مجموعة فارغة من الملفات القابلة للاستخدام. تحقّق من status.msg؛ فحالة HTTP 200 وحدها لا تكفي.

ارفع الملفات وأرفقها خلال فترة صلاحية مراجع الملفات المُعادة. إذا لم تكن نتيجة الاستجابة مؤكدة، فتحقّق من المستندات الداعمة للهوية في البوابة قبل إعادة المحاولة. لا يتيح هذا المعالج أي مفتاح لضمان عدم تكرار أثر الطلب.