შექმენით პროფილი ერთხელ
ეს მოთხოვნა ქმნის ლოკალურ სარეგისტრაციო პროფილს ოპერატორის იდენტობისა და მისამართის ჩანაწერებთან ერთად. დაიწყეთ მიმდინარე სარეგისტრაციო ქვეყნებით, ნომრის ტიპებით და მოთხოვნებით. მოთხოვნები დამოკიდებულია ქვეყანასა და იმ ნომრის ტიპზე, რომლის რეგისტრაციასაც გეგმავთ.
წარმატებული შექმნის პასუხი არ ნიშნავს მარეგულირებელ დამტკიცებას ან ნომრის გააქტიურებას. შეინახეთ დოკუმენტის UUID, იდენტობის ID და მისამართის ID ცალ-ცალკე: ისინი სხვადასხვა მიზანს ემსახურება. ეს მოთხოვნა ცვლის ანგარიშის მონაცემებს და არ არის მხოლოდ ვალიდაციის ოპერაცია.
შექმნის მოთხოვნა
ავტორიზაცია გაიარეთ თქვენი გააქტიურებული MultiTEL API ანგარიშითა და მისი დაშვებული IP მისამართით. მაგალითებში გამოყენებულია გარემოს ცვლადებში შენახული HTTP Basic ავტორიზაციის მონაცემები. შეამოწმეთ როგორც HTTP პასუხი, ისე JSON status.code; მხოლოდ HTTP 200 პასუხი წარმატებას არ ადასტურებს. მაგალითების ყველა მნიშვნელობა გამოგონილია.
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
--header 'Content-Type: application/json' \
--data @registration-profile.json \
https://api.multitel.net/v3/create_document{
"identity_type": "Personal",
"first_name": "Example",
"last_name": "Person",
"phone_number": "12025550123",
"email": "end-user@example.com",
"city": "Example City",
"postal_code": "00000",
"country": "US",
"address": "1 Example Street",
"nationality": "US",
"signature": "BASE64_PNG_OF_THE_AUTHORIZED_END_USER_SIGNATURE"
}ეს JSON საილუსტრაციო Personal პროფილია და არა გასაგზავნად მზა რეალური იდენტობა. ჩაანაცვლეთ მისი მონაცემები და ხელმოწერა საბოლოო მომხმარებლის იმ ინფორმაციით, რომელსაც არჩეული რეგისტრაციის წესები მოითხოვს. მხარდაჭერილია form-encoded შეყვანაც.
| ველი | სავალდებულოობა და ფორმატი |
|---|---|
identity_type | სავალდებულოა. გამოიყენეთ ზუსტი მნიშვნელობა Personal ან Business; პირობითი ვალიდაცია დამოკიდებულია ასოების რეგისტრზე. |
first_name, last_name | სავალდებულოა, თითოეული არაუმეტეს 64 სიმბოლოსი. ბიზნესის შემთხვევაში მიუთითეთ წარმომადგენლის მონაცემები, რომლებსაც არჩეული ქვეყანა მოითხოვს. |
phone_number | სავალდებულო რიცხვითი სატელეფონო მნიშვნელობა, სულ მცირე რვა სიმბოლო. ამ ვალიდაციისთვის შესაფერისია მხოლოდ ციფრებისგან შემდგარი საერთაშორისო ნომერი ქვეყნის კოდის ჩათვლით; ეს საკონტაქტო ნომერია და არა ნომრის შესყიდვა. |
city, postal_code, address | სავალდებულოა, თითოეული არაუმეტეს 64 სიმბოლოსი. |
country | სავალდებულოა მისამართის ქვეყნის ISO კოდი რეგისტრაციის კატალოგიდან. სერვისი მას ოპერატორის ქვეყნის ჩანაწერთან აკავშირებს. |
signature | სავალდებულო ხელმოწერის მონაცემები. მიმდინარე პორტალი აწვდის Base64 PNG გამოსახულების ბაიტებს data:image/png;base64, პრეფიქსის გარეშე. საბოლოო მომხმარებლის ხელმოწერა მოიპოვეთ თქვენი ავტორიზებული სამუშაო პროცესის მეშვეობით; არაცარიელი შემავსებელი მნიშვნელობა არ არის რეალური ხელმოწერა. |
nationality | სავალდებულოა Personal ტიპისთვის, ქვეყნის ISO კოდის სახით. მის ნაცვლად ქვეყნის UUID არ გამოიყენოთ. |
company_name, incorporation_country | სავალდებულოა Business ტიპისთვის. კომპანიის სახელი არაუმეტეს 64 სიმბოლოსია; incorporation_country ქვეყნის ISO კოდია. |
email | საბოლოო მომხმარებლის არასავალდებულო საკონტაქტო ელფოსტა, არაუმეტეს 254 სიმბოლოსი. გამოტოვებული ან ცარიელი ელფოსტა ძირითადი ანგარიშის ელფოსტას არ იღებს მემკვიდრეობით. |
company_reg_number, vat_id, id_number, personal_tax_id, birth_date, description | ამ დამმუშავებელში არასავალდებულოა, მაგრამ არჩეულმა ქვეყანამ/ოპერატორმა შეიძლება ზოგიერთი მათგანი მოითხოვოს. მიუთითეთ ამ რეგისტრაციისთვის საჭირო ფორმატები. პირდაპირი API გამოძახებები ავტომატურად არ იყენებს ყველა იმ ნორმალიზაციას, რომელსაც პორტალი ასრულებს. |
ეს პირდაპირი v3 დამმუშავებელი მოითხოვს მისამართის ველებს და ქმნის მისამართს. არ ივარაუდოთ, რომ პორტალის მისამართის გადადების ოფცია მისი მეშვეობით ხელმისაწვდომია.
შეინახეთ სამივე იდენტიფიკატორი
ქვემოთ ნაჩვენებია პასუხის შერჩეული ველები; რეალური პასუხი ასევე შეიცავს გაგზავნილი პროფილის ინფორმაციასა და ხელმოწერის მონაცემებს. სრულ პასუხს კონფიდენციალურად მოეპყარით.
{
"status": {
"code": 200,
"msg": "Success Create Registration Detail."
},
"response": {
"uuid": "11111111111111111111111111111111",
"identity_id": "22222222222222222222222222222222",
"address_id": "33333333333333333333333333333333",
"country_iso": "US",
"email": "end-user@example.com"
}
}response.uuidგანსაზღვრავს ლოკალურ პროფილს. გამოიყენეთ იგი get_document მოთხოვნაში. documents და get_document პასუხებში იმავე პროფილის იდენტიფიკატორს ეწოდებაid.response.identity_idგანსაზღვრავს იდენტობას შემდგომი იდენტობის მტკიცებულებებისთვის და დამხმარე დოკუმენტებისთვის.response.address_idგანსაზღვრავს შექმნილ მისამართს. შეინახეთ იგი ცალკე; ლოკალური პროფილის UUID მისამართის ID არ არის. ახლად შექმნილი პროფილებისთვის მისამართის მტკიცებულების შემდგომი მიმაგრების თავსებადობა ჯერ კიდევ განხილვის პროცესშია.
პროფილის წაკითხვის ორი ბოლო წერტილი არ აბრუნებს identity_id-ს ან address_id-ს, ამიტომ შეინახეთ თავდაპირველი წარმატებული შექმნის პასუხი. თუ იგი დაიკარგა, გამოიყენეთ პორტალის დოკუმენტების ხედი ან დაუკავშირდით მხარდაჭერის სამსახურს ჩანაცვლების შექმნამდე.
გაფართოებული: წინასწარ ატვირთული მტკიცებულებების მიმაგრება შექმნისას
შეგიძლიათ მიუთითოთ identity_encryptfiles და address_encryptfiles იმ ID-ების მასივების სახით, რომლებსაც აბრუნებს create_encrypt_files. ატვირთეთ შესაბამისი ობიექტის კატეგორიის მტკიცებულების ტიპით, შემდეგ გაგზავნეთ ფაილის რეფერენსის დაახლოებით 20-წუთიანი ვადის ამოწურვამდე. შექმნის დამმუშავებელი ამოწმებს თითოეული მოწოდებული რეფერენსის ანგარიშს, კატეგორიასა და ვადას.
ამ ველებს განსხვავებული სახელები აქვს შემდგომი მიმაგრების ბოლო წერტილის encrypted_file_ids-ისგან. შექმნისას თითოეული ფაილი იგზავნება ცალკე მტკიცებულების მოთხოვნად, მაშინაც კი, როცა რამდენიმე ფაილს ერთი მტკიცებულების ტიპი აქვს. იდენტობის მტკიცებულებისთვის, რომელიც რამდენიმე ფაილს ერთად უნდა შეიცავდეს, გამოიყენეთ შემდგომი create_proof მოთხოვნა ერთი მასივით. მხოლოდ პროფილის წარმატებული შექმნა არ იძლევა ცალკეული მტკიცებულებების დამტკიცების შედეგებს.
თუ ახლად შექმნილი მისამართისთვის შემდგომი მისამართის მტკიცებულება უარყოფილია, მის ნაცვლად პროფილის UUID არ გამოიყენოთ და იდენტობა განმეორებით არ შექმნათ. შეჩერდით და შეამოწმეთ პროფილი პორტალში ან მხარდაჭერის სამსახურთან ერთად. მისამართის მტკიცებულების წაკითხვის/მოძიების გზა განხილვის შეზღუდვად რჩება.
შეცდომები და ნაწილობრივი შექმნა
API კოდი 400 მოიცავს ველების ვალიდაციას, ოპერატორთან შექმნის შეცდომებსა და ლოკალური შენახვის შეცდომებს. ვალიდაციის შეცდომები შეიძლება გამოჩნდეს response-ში ველების სახელებით გასაღებიანი ჩანაწერების სახით. კოდი 500 გამოიყენება მიუწვდომელი/არასწორი რეგისტრაციის ქვეყნისთვის, ხოლო კოდი 404 გამოიყენება არარსებული ან ვადაგასული წინასწარ ატვირთული რეფერენსებისთვის. კოდთან ერთად წაიკითხეთ status.msg.
ლოკალური პროფილისა და ზედა დონის ოპერატორის ოპერაციები ერთი ატომური ტრანზაქცია არ არის. წარუმატებელმა მოთხოვნამ შეიძლება ოპერატორის მხარეს მდგომარეობა დატოვოს მაშინაც კი, როცა ლოკალური პროფილი სიაში არ არის. კლიენტის იდემპოტენტურობის გასაღები არ არის ხელმისაწვდომი. ვადის ამოწურვის ან გაურკვეველი შეცდომის შემდეგ შეამოწმეთ არსებული პროფილები და დაუკავშირდით მხარდაჭერის სამსახურს შექმნის გამეორებამდე; ცარიელი documents სია არ ადასტურებს, რომ ოპერატორის მხარეს არაფერი შექმნილა.