დეველოპერებისთვის

POST/v3/update_document/{uuid}

სარეგისტრაციო პროფილის განახლება

გაგზავნეთ პროფილის ყველა რედაქტირებადი მონაცემი და დაამუშავეთ წარმატების პასუხის ძველი ფორმატი.

ამ გვერდზე
  1. პროფილის რედაქტირებადი მონაცემების ჩანაცვლება
  2. განახლების მოთხოვნა
  3. დამატებითი პარამეტრები: წინასწარ ატვირთული დამადასტურებელი დოკუმენტების დამატება
  4. წარმატებისა და წარუმატებლობის პასუხების ძველი ფორმატი
  5. განახლების მიმდინარე შეზღუდვები და აღდგენა

პროფილის რედაქტირებადი მონაცემების ჩანაცვლება

ანგარიშის კუთვნილი არსებული სარეგისტრაციო პროფილის გასაახლებლად გამოიყენეთ მისი ლოკალური UUID, რომელსაც აბრუნებს create_document ან documents. ეს ოპერაცია ცვლის ანგარიშისა და ზედა დონის ოპერატორის მონაცემებს. ის არ ცვლის შენახულ Personal/Business იდენტობის ტიპს და არ წარმოადგენს ცალკეული ველების ნაწილობრივ PATCH განახლებას.

განახლების მოთხოვნა

გაიარეთ ავთენტიფიკაცია ნებადართული IP მისამართიდან თქვენი გააქტიურებული MultiTEL API ანგარიშით. მაგალითებში გამოიყენება გარემოს ცვლადებში შენახული ავტორიზაციის მონაცემები და გამოგონილი მონაცემები. HTTP პასუხთან ერთად წაიკითხეთ JSON-ის status.code და status.msg ველებიც.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --header 'Content-Type: application/json' \
  --data @registration-profile-update.json \
  "https://api.multitel.net/v3/update_document/$DOCUMENT_UUID"
{
  "first_name": "Example",
  "last_name": "Person",
  "phone_number": "12025550123",
  "email": "end-user@example.com",
  "city": "Example City",
  "postal_code": "00000",
  "address": "1 Example Street",
  "country": "US",
  "nationality": "US",
  "signature": "BASE64_PNG_OF_THE_AUTHORIZED_END_USER_SIGNATURE",
  "id_number": "",
  "personal_tax_id": "",
  "birth_date": "",
  "description": "Example profile",
  "company_name": "",
  "company_reg_number": "",
  "incorporation_country": "",
  "vat_id": "",
  "address_description": ""
}

მაგალითში ნაჩვენებია Personal პროფილი; ჩაანაცვლეთ ის საბოლოო მომხმარებლის ყველა სასურველი მონაცემითა და მისი უფლებამოსილი ხელმოწერით. მონაცემების შესანარჩუნებლად არ გაგზავნოთ ხელმოწერის დროებითი ნიმუშები ან ცარიელი მნიშვნელობები. მხარდაჭერილია JSON და ფორმის ფორმატში კოდირებული შემავალი მონაცემები.

მოთხოვნები განახლების ველების მიმართ
ველებიქცევა
first_name, last_name, city, postal_code, addressსავალდებულოა; თითოეული არაუმეტეს 64 სიმბოლოსი უნდა იყოს.
phone_numberსავალდებულოა სულ მცირე რვა სიმბოლოსგან შემდგარი რიცხვითი მნიშვნელობა; გამოიყენეთ ციფრები საერთაშორისო ფორმატში, ქვეყნის კოდის ჩათვლით.
signatureსავალდებულოა. პორტალი აწვდის Base64 ფორმატში კოდირებულ PNG ბაიტებს მონაცემთა URL-ის პრეფიქსის გარეშე.
countryმიუთითეთ მისამართის ქვეყნის ISO კოდი რეგისტრაციის კატალოგიდან. დამმუშავებელი ამ კოდით ადგენს ქვეყანას, თუმცა მისამართის განახლების განხილული მექანიზმი ქვეყანასთან კავშირს არ ცვლის.
nationalityარსებული Personal პროფილისთვის სავალდებულოა ქვეყნის ISO კოდი.
company_name, incorporation_countryსავალდებულოა არსებული Business პროფილისთვის; კომპანიის სახელი არაუმეტეს 64 სიმბოლოსი უნდა იყოს, ხოლო დაფუძნების ქვეყანა ISO კოდით უნდა მიეთითოს.
emailარასავალდებულო მოქმედი ელფოსტის მისამართი, არაუმეტეს 254 სიმბოლოსი. შენახული საკონტაქტო ელფოსტის შესანარჩუნებლად გამოტოვეთ ეს ველი; მის ლოკალურად გასასუფთავებლად გაგზავნეთ ცარიელი მნიშვნელობა.
id_number, personal_tax_id, birth_date, description, company_reg_number, vat_idგაგზავნეთ სასურველი მიმდინარე მნიშვნელობები. გამოტოვებული მნიშვნელობები ნაგულისხმევად ცარიელია და შეიძლება არსებულ შენახულ მნიშვნელობებს გადააწეროს.

ქვეყნისთვის დამახასიათებელი რეგისტრაციის წესები შეიძლება დამატებით ინფორმაციას ან ფორმატებს მოითხოვდეს. სრული განახლების მონაცემების აღსადგენად არ დაეყრდნოთ get_document პასუხს მხოლოდ: მისი შეზღუდული პასუხი არ შეიცავს ქვეყნის არჩევის ველებს, email ველსა და სუბიექტების ID-ებს. შეინახეთ საწყისი მონაცემები, რომელთა გამოყენების უფლებაც გაქვთ, ან გამოიყენეთ პორტალის დოკუმენტების რედაქტორი.

დამატებითი პარამეტრები: წინასწარ ატვირთული დამადასტურებელი დოკუმენტების დამატება

არასავალდებულო identity_encryptfiles და address_encryptfiles მასივები იღებს აქტიურ, ანგარიშის კუთვნილ მითითებებს, რომლებსაც აბრუნებს create_encrypt_files. მიუსადაგეთ ატვირთვის სუბიექტის კატეგორია და გაგზავნეთ მითითების ვადის ამოწურვამდე. თითოეული ფაილი ერთვის ცალკე დამადასტურებელ მოთხოვნას, მაშინაც კი, თუ რამდენიმე ფაილს დამადასტურებელი დოკუმენტის ერთი და იგივე ტიპი აქვს. რამდენიმე ფაილისგან შემდგარი პირადობის დამადასტურებელი დოკუმენტისთვის გამოიყენეთ შემდგომი დამადასტურებელი დოკუმენტის მიმაგრების პროცესი ერთი მასივით.

თუ ახლად შექმნილი მისამართისთვის შემდგომი მისამართის მტკიცებულება უარყოფილია, მის ნაცვლად პროფილის UUID არ გამოიყენოთ და იდენტობა განმეორებით არ შექმნათ. შეჩერდით და შეამოწმეთ პროფილი პორტალში ან მხარდაჭერის სამსახურთან ერთად. მისამართის მტკიცებულების წაკითხვის/მოძიების გზა განხილვის შეზღუდვად რჩება.

წარმატებისა და წარუმატებლობის პასუხების ძველი ფორმატი

{
  "status": {
    "code": "success",
    "msg": "Successfully Saved."
  },
  "response": ""
}

ამ საბოლოო წერტილის წარმატების ჩვეულებრივი კოდია სტრიქონი success, რიცხვითი 200 კოდის ნაცვლად. ზედა დონის სისტემაში ან ლოკალურად ჩვეულებრივი წარუმატებლობისას შეიძლება გამოყენებული იყოს სტრიქონი error. რიცხვითი 400 აღნიშნავს არასწორ ველებს ან დამადასტურებელ დოკუმენტებთან დაკავშირებულ წარუმატებლობას, 404 — არარსებულ პროფილს ან ატვირთული ფაილის არასწორ მითითებას, ხოლო 500 — ცარიელ სხეულს ან ქვეყანას, რომლის განსაზღვრაც ვერ მოხერხდა. წაიკითხეთ შეტყობინება და ვალიდაციის ყველა ჩანაწერი; მხოლოდ HTTP 200 არ მიიჩნიოთ წარმატების დასტურად.

განახლების მიმდინარე შეზღუდვები და აღდგენა

წარმატების შესახებ პასუხი არ იძლევა გარანტიას, რომ ზედა დონის სისტემაში ყველა ველი შეიცვალა. განხილულ კოდს შეუძლია ლოკალური პროფილის შენახვა მას შემდეგაც, რაც ზედა დონის სისტემაში მისამართის განახლება ვერ შესრულდება. ზედა დონის სისტემაში იდენტობის განახლება არ მოიცავს email ველს. ამ გზით მისამართის ქვეყნის ცვლილება და მისამართის აღწერის სინქრონიზაცია დადასტურებული არ არის. თუ ეს ცვლილებები გჭირდებათ, გადაამოწმეთ შედეგი პორტალში და დაუკავშირდით მხარდაჭერას; ნუ ჩათვლით ავტომატურად, რომ ზედა დონის სისტემაში რეგისტრაცია განახლდა.

განახლება ერთ ატომურ ტრანზაქციას არ წარმოადგენს: იდენტობის ცვლილებები და დამადასტურებელი დოკუმენტების მიმაგრება შეიძლება მოგვიანებით მომხდარ წარუმატებლობამდე შესრულდეს. იდემპოტენტურობის გასაღები ხელმისაწვდომი არ არის. გაურკვეველი პასუხის შემდეგ, ხელახლა ცდამდე შეამოწმეთ პროფილი და დანართები; დამადასტურებელი დოკუმენტების განმეორებით გაგზავნამ შეიძლება დუბლიკატები შექმნას. პროფილის განახლება არ ადასტურებს დამადასტურებელი დოკუმენტის დამტკიცებას და არ ააქტიურებს ნომერს.