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
namestringnull мәнін қабылдай алады

Бос мән өрісті тазартады

Мысал: 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_numberstringnull мәнін қабылдай алады

Тек телефон тек phone_format_id бірге қолданылады; телефон міндетті

Мысал: (952) 056-31-65

telegram_user_idstringnull мәнін қабылдай алады

Тек қана сандар; бос мән өрісті тазартады

Мысал: 476962294

timezonestring

Мысал: Europe/Kaliningrad

languagestring

Мысал: ru

photostring · binarynull мәнін қабылдай алады

Файл ауыстырады аватарды; бос мәтіндік өріс оны өшіреді

passwordstring

Жаңа құпиясөз; тек old_password параметрімен бірге

Мысал: 987654321

old_passwordstring

Ағымдағы құпиясөз; құпиясөзді өзгерткенде міндетті

Мысал: 123456789

otp_enabledboolean

true екі факторлы аутентификацияны қосады және 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