معاون دستاویز منسلک کریں

سانچے پر مبنی معاون دستاویز منسلک کریں

یہاں سے سانچہ حاصل کریں: get_supporting_document_templates، اور ایسا شناختی ریکارڈ استعمال کریں جو پہلے ہی آپ کے اکاؤنٹ کی ملکیت ہو۔ اس کی فائلیں اس ذریعے سے اپ لوڈ کریں: create_encrypt_files، اس فیلڈ کو استعمال کرتے ہوئے: supporting_template_id۔ شناخت یا پتے کے ثبوت کے لیے عام طور پر اپ لوڈ کی گئی فائلیں ایک الگ زمرے میں آتی ہیں اور انہیں متبادل کے طور پر استعمال نہیں کیا جا سکتا۔

معاون دستاویز بنائیں

MultiTEL کا فعال API اکاؤنٹ اور اس کا مجاز 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"
  }
}

یہ معاون دستاویز بن جانے کی تصدیق ہے، ضابطہ جاتی منظوری یا نمبر فعال ہونے کی نہیں۔ اصل بالائی ماخذ میں استعمال ہونے والی اصطلاح «مستقل» صارف کے لیے ذخیرہ کرنے کی مدت یا حذف کرنے کی پالیسی کی ضمانت نہیں ہے۔

خرابیاں اور دوبارہ کوششیں

API کا کوڈ 500 نامکمل فراہم کردہ معلومات، ٹیلی کام آپریٹر کی خرابیوں یا اس کے نامعتبر جواب کو ظاہر کرتا ہے۔ کوڈ 404 ایسے شناختی ریکارڈ کو ظاہر کرتا ہے جو اکاؤنٹ سے وابستہ نہ ہو، نامعتبر سانچے، غائب، میعاد ختم شدہ یا غلط زمرے کے اپ لوڈز، یا قابل استعمال فائلوں کے خالی مجموعے کو ظاہر کرتا ہے۔ یہ فیلڈ جانچیں: status.msg؛ صرف HTTP 200 کافی نہیں ہے۔

واپس ملنے والے فائل حوالوں کی مدتِ اعتبار کے اندر فائلیں اپ لوڈ اور منسلک کریں۔ ایسا جواب ملنے کے بعد جس کا نتیجہ غیر یقینی ہو، دوبارہ کوشش کرنے سے پہلے پورٹل میں شناختی ریکارڈ کی معاون دستاویزات دیکھیں۔ یہ ہینڈلر تکراری درخواستوں کے یکساں اثر کو یقینی بنانے کی کوئی کلید فراہم نہیں کرتا۔