შაბლონზე დაფუძნებული დამადასტურებელი დოკუმენტის მიბმა
გამოიყენეთ შაბლონი, რომელსაც აბრუნებს 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 საკმარისი არ არის.
ფაილები ატვირთეთ და მიაბით დაბრუნებული ფაილის მითითების მოქმედების ვადაში. გაურკვეველი პასუხის მიღების შემდეგ, განმეორებით მცდელობამდე, პორტალში შეამოწმეთ პირის საიდენტიფიკაციო ჩანაწერზე მიბმული დამადასტურებელი დოკუმენტები. ეს დამმუშავებელი იდემპოტენტურობის გასაღებს არ უზრუნველყოფს.