API

პროფილის პარამეტრების შენახვა

POST/api/crm/v2/profile.updatev2
operationId: profile.update

მიმდინარე მომხმარებლის პროფილის ნაწილობრივი განახლება: მუშავდება მხოლოდ გადაცემული გასაღებები, დანარჩენი ველები არ იცვლება. გამოიყენება როგორც ერთი ველის, ასევე მთელი ფორმის ერთ მოთხოვნაში შენახვისთვის.

ცარიელი მნიშვნელობა ასუფთავებს ველს (name, telegram_user_id, ტელეფონი, photo). თუ მნიშვნელობა სავალდებულოა, ცარიელი აბრუნებს შეცდომას 118: timezone, language და ტელეფონი.

Email აქ არ იცვლება: ლოგინის შეცვლა მოითხოვს დადასტურებას, ამისთვის არსებობს ცალკე profile.request_email_change და profile.cancel_email_change.

ტელეფონი — ორი გასაღების წყვილია, ისინი ერთად უნდა გადაიგზავნოს: ერთის გარეშე მეორის გადაცემა აბრუნებს შეცდომას 117. პაროლის შეცვლა მოითხოვს old_password-ს (შეცდომა 128, თუ არ ემთხვევა), აგზავნის შეტყობინებას email-ზე და ასრულებს ყველა მომხმარებლის სესიას, მათ შორის მიმდინარე სესიას: ავტორიზაციის მონაცემები შეიცვალა, ამიტომ საჭიროა ხელახლა შესვლა. 2FA-ს ჩართვა მოითხოვს სწორ otp კოდს, გამორთვა — არა; otp_reset გამოყოფს ახალ საიდუმლოს, ტოვებს 2FA-ს გამორთულ მდგომარეობაში და აბრუნებს secret და qr ახალ მიბმაზე.

ავტორიზაცია

api-token + language + role

მოთხოვნის სხეული multipart/form-data

object
namestringშეიძლება იყოს null

ცარიელი მნიშვნელობა ასუფთავებს ველს

მაგალითი: John Smith

phone_format_idinteger (PhoneFormatId)

ქვეყნის კოდი: 1-🇷🇺(+7|8), 2-🇦🇿(+994|0), 3-🇧🇾(+375|80), 4-🇰🇿(+7|8), 6-🇷🇸(+381|0), 7-🇹🇷(+90|0), 8-🇺🇦(+380|0), 9-🇵🇹(+351|0), 10-🇰🇬(+996|0), 11-🇺🇸(+1), 12-🇫🇷(+33|0), 13-🇲🇩(+373|0), 15-🇪🇪(+372), 18-🇬🇪(+995), 19-🇺🇿(+998), 22-🇵🇱(+48|0), 23-🇹🇯(+992|8), 25-🇷🇴(+40|0), 44-🇨🇭(+41|0)

მაგალითი: 1

phone_numberstringშეიძლება იყოს null

მხოლოდ phone_format_id-თან ერთად; ტელეფონი სავალდებულოა

მაგალითი: (952) 056-31-65

telegram_user_idstringშეიძლება იყოს null

მხოლოდ ციფრები; ცარიელი მნიშვნელობა ასუფთავებს ველს

მაგალითი: 476962294

timezonestring

მაგალითი: Europe/Kaliningrad

languagestring

მაგალითი: ru

photostring · binaryშეიძლება იყოს null

ფაილი ცვლის ავატარს; ცარიელი ტექსტური ველი შლის მას

passwordstring

ახალი პაროლი; მხოლოდ old_password-თან ერთად

მაგალითი: 987654321

old_passwordstring

მიმდინარე პაროლი; სავალდებულოა პაროლის შეცვლისას

მაგალითი: 123456789

otp_enabledboolean

true ჩართავს 2FA-ს და მოითხოვს otp, false გამორთავს მას

მაგალითი: true

otp_resetboolean

გამოშვებს ახალ 2FA საიდუმლოს; 2FA დარჩება გამორთული ახალ მიბმამდე

მაგალითი: false

otpstring

მიმდინარე საიდუმლოს კოდი; სავალდებულოა 2FA-ის ჩართვისას და otp_reset-ის დროს

მაგალითი: 192870

პასუხები

OK

object
statusstringსავალდებულო

მნიშვნელობები:successerror

მაგალითი: success

dataobject
descriptionstring

მაგალითი: Successfully saved

photostring

არის, თუ ავატარი შეცვლილია

მაგალითი: data:image/jpeg;base64,/9j/4AAQSkZJRg...

secretstring

არის otp_reset დროს

მაგალითი: KA2G2UKBHBBHKOJR

qrstring

არის otp_reset დროს

მაგალითი: https://api.qrserver.com/v1/create-qr-code/?data=otpauth%3A%2F%2Ftotp%2FFS%2520Admin%3Akalabunga82%40gmail.com%3Fsecret%3DKA2G2UKBHBBHKOJR%26issuer%3DFS%2520Admin&size=520x520&margin=15