المطوّرون

GET/v3/get_supporting_document_templates/{iso}

عرض قائمة قوالب المستندات الداعمة

اعثر على معرّفات القوالب وأسمائها والمعلومات الاسترشادية عن بلدانها قبل إعداد مستند داعم.

في هذه الصفحة
  1. تصفّح فهرس القوالب
  2. استعن بالمتطلبات لاختيار قالب
  3. إذا لم تُرجع الخدمة أي قوالب
  4. راجع النسخة التي نزّلتها قبل استخدامها
  5. الطلب
  6. الاستجابة
  7. الأخطاء
  8. التوفّر والآثار الجانبية

تصفّح فهرس القوالب

احذف مقطع المسار الاختياري الخاص برمز ISO لعرض قائمة القوالب التي تُرجعها الخدمة. قدّم رمز ISO لبلد لتصفية القائمة. يعتمد عامل التصفية على مطابقة المعلومة الاسترشادية عن بلد القالب، والتي قد تُستنتج من الاسم وقد تكون فارغة.

استعن بالمتطلبات لاختيار قالب

وجود قالب لا يعني أنه مطلوب أو مقبول لكل رقم في ذلك البلد. طابق معرّف القالب مع متطلبات المستندات الداعمة المنطبقة. لا تُنشئ هذه القائمة مستندًا مكتملًا ولا توقّعه أو ترفعه أو توافق عليه.

إذا لم تُرجع الخدمة أي قوالب

قد تعني القائمة المصفّاة الفارغة عدم العثور على معلومة استرشادية مطابقة عن البلد. وقد تعكس القائمة الفارغة غير المصفّاة أيضًا عدم توفّر البيانات لدى المصدر الذي تعتمد عليه الخدمة. لا تعتبر أيًا من النتيجتين دليلًا على عدم الحاجة إلى مستند داعم.

راجع النسخة التي نزّلتها قبل استخدامها

قد يُرجع رابط التنزيل في الفهرس نسخة تتضمن تغييرات في التنسيق أو العلامة التجارية. لا تفترض أنها الاتفاقية الأصلية دون تغيير، أو أن تنزيلها يستوفي أحد متطلبات التسجيل. راجع المحتويات قبل تعبئة أي مستند أو توقيعه.

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

الطلب

استخدم بيانات اعتماد حساب API المفعّل لديك عبر HTTPS. تُدعَم مصادقة Basic ورموز bearer المفعّلة لحساب API؛ وتُطبّق قيود الحساب.

استخدم GET مع أي معلمة موثّقة في مسار عنوان URL.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_supporting_document_templates/$COUNTRY_ISO"
معلمات المسار
الاسمالنوعمطلوبالوصف
isostringلاعامل تصفية اختياري حسب رمز ISO للبلد. احذف مقطع المسار هذا بالكامل للحصول على القائمة غير المصفّاة. لا تميّز المقارنة بين الأحرف الكبيرة والصغيرة. تُرجع القيم غير المعروفة أو غير المطابقة قائمة فارغة بدلًا من خطأ صريح يفيد بأن البلد غير صالح.

الاستجابة

تحقّق من status.code في متن JSON وكذلك من حالة HTTP. يمثّل response مصفوفة من الكائنات التي تحتوي على id وname وpermanent وiso وurl. قيمة permanent من النوع boolean؛ وقد تكون قيمة iso فارغة وقد تكون مستنتجة من اسم القالب. تعامل مع معلومات البلد بوصفها معلومات استرشادية، لا قرارًا بشأن الأهلية. يُعدّ الفهرس الفارغ استجابة ناجحة برمز 200، وقد ينتج أيضًا عندما لا يُرجع البحث في المصدر الذي تعتمد عليه الخدمة أي بيانات. تُنشئ الخدمة عنوان URL؛ وقد يختلف اسم المضيف فيه عن المثال التوضيحي.

بنية توضيحية للاستجابة؛ وليست بيانات فعلية مباشرة من الحساب أو عرض سعر حاليًا.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "id": "TEMPLATE_ID_FROM_RESPONSE",
      "name": "Example supporting-document template",
      "permanent": false,
      "iso": "US",
      "url": "https://api.multitel.net/v3/supporting_document/TEMPLATE_ID_FROM_RESPONSE"
    }
  ]
}

الأخطاء

  • تحقّق من status.code وstatus.msg للاطّلاع على أخطاء المصادقة أو الخدمة. لا يمثّل إرجاع فهرس فارغ بنجاح موافقة على مستند أو إعفاءً من التسجيل.

التوفّر والآثار الجانبية

  • لا تؤدي عملية البحث هذه في الفهرس أو المتطلبات إلى إنشاء هوية أو رفع إثبات أو تسجيل رقم أو تقديم طلب شراء.
  • لا تعني الاستجابة الناجحة للفهرس الموافقة على مستنداتك أو التأكيد على إمكانية تفعيل رقم محدّد.