API

Profil ayarlarını yadda saxla

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

Cari istifadəçinin profilini qismən yeniləyir: yalnız göndərilən açarlar işlənir, digər sahələr dəyişmir. Həm bir sahənin, həm də bütün formanı bir sorğu ilə saxlamaq üçün uyğundur.
Boş dəyər sahəni təmizləyir (name, telegram_user_id, telefon, photo). Əgər dəyər məcburidirsə, boş göndərildikdə 118 xətası qaytarılır: timezone, language və telefon.
Email burada dəyişdirilmir: loginin dəyişməsi təsdiq tələb edir, bunun üçün ayrıca profile.request_email_change və profile.cancel_email_change əməliyyatları mövcuddur.
Telefon — iki açarın cütüdür, birlikdə göndərilməlidir: biri olmadan digəri 117 xətası qaytarır. Parolun dəyişməsi üçün old_password tələb olunur (əgər uyğun gəlmirsə, 128 xətası), emailə bildiriş göndərilir və istifadəçinin bütün sessiyaları, o cümlədən cari sessiya bitirilir: giriş məlumatları dəyişdiyinə görə yenidən daxil olmaq lazımdır.
2FA-nın aktivləşdirilməsi düzgün otp kodu tələb edir, deaktivasiya üçün tələb olunmur; otp_reset yeni sirr yaradır, 2FA-nı deaktiv saxlayır və yeni qoşulma üçün secret və qr qaytarır.

Avtorizasiya

api-token + language + role

Sorğu gövdəsi multipart/form-data

object
namestringnull ola bilər

Boş dəyər sahəni təmizləyir

Nümunə: John Smith

phone_format_idinteger (PhoneFormatId)

Ölkə kodu: 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)

Nümunə: 1

phone_numberstringnull ola bilər

Yalnız phone_format_id ilə birlikdə; telefon mütləqdir

Nümunə: (952) 056-31-65

telegram_user_idstringnull ola bilər

Yalnız rəqəmlər; boş dəyər sahəni təmizləyir

Nümunə: 476962294

timezonestring

Nümunə: Europe/Kaliningrad

languagestring

Nümunə: ru

photostring · binarynull ola bilər

Fayl avatarı əvəz edir; boş mətn sahəsi onu silir

passwordstring

Yeni şifrə; yalnız old_password ilə birlikdə

Nümunə: 987654321

old_passwordstring

Cari şifrə; şifrəni dəyişərkən tələb olunur

Nümunə: 123456789

otp_enabledboolean

true 2FA-ni aktiv edir və otp tələb olunur, false isə onu deaktiv edir

Nümunə: true

otp_resetboolean

Yeni 2FA sirri buraxılır; 2FA yeni qoşulana qədər deaktiv qalır

Nümunə: false

otpstring

Cari sirrin kodu; 2FA aktivləşdirilərkən və otp_reset zamanı tələb olunur

Nümunə: 192870

Cavablar

OK

object
statusstringmütləq

Dəyərlər:successerror

Nümunə: success

dataobject
descriptionstring

Nümunə: Successfully saved

photostring

Var, əgər avatar dəyişdirilibsə

Nümunə: data:image/jpeg;base64,/9j/4AAQSkZJRg...

secretstring

otp_reset zamanı mövcuddur

Nümunə: KA2G2UKBHBBHKOJR

qrstring

otp_reset zamanı mövcuddur

Nümunə: 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