Salvesta profiili seaded

POST/api/crm/v2/profile.updatev2

operationId: profile.update

Uuendab osaliselt praeguse kasutaja profiili: töödeldakse ainult edastatud võtmeid, teisi välju ei muudeta. Sobib nii ühe välja kui kogu vormi salvestamiseks ühe päringuga.
Tühi väärtus puhastab välja (name, telegram_user_id, telefon, photo). Kui väärtus on kohustuslik, tagastab tühi väärtus vea 118: timezone, language ja telefon.
Emaili siin ei muudeta: sisselogimise muutmine nõuab kinnitust, selleks on eraldi profile.request_email_change ja profile.cancel_email_change.
Telefon on võtmete paar, need tuleb edastada koos: ühe puudumine tagastab vea 117. Parooli muutmine nõuab old_password (viga 128, kui see ei ühti), saadab teavituse emailile ja lõpetab kõik kasutaja sessioonid, sh praeguse: autentimisandmed on muutunud, seega tuleb uuesti sisse logida. 2FA lubamine nõuab korrektset otp koodi, keelamine mitte; otp_reset väljastab uue saladuse, jätab 2FA keelatuks ning tagastab secret ja qr uue sidumise jaoks.

Autoriseerimine

api-token + language + role

Päringu keha `multipart/form-data`

object

namestringvõib olla null

Tühi väärtus puhastab välja

Näide: John Smith

phone_format_idinteger (PhoneFormatId)

Riigikood: 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äide: 1

phone_numberstringvõib olla null

Ainult koos phone_format_id; telefon on kohustuslik

Näide: (952) 056-31-65

telegram_user_idstringvõib olla null

Ainult numbrid; tühi väärtus puhastab välja

Näide: 476962294

timezonestring

Näide: Europe/Kaliningrad

languagestring

Näide: ru

photostring · binaryvõib olla null

Fail asendab avatari; tühi tekstiväli eemaldab selle

passwordstring

Uus parool; ainult koos old_password

Näide: 987654321

old_passwordstring

Praegune parool; vajalik parooli muutmisel

Näide: 123456789

otp_enabledboolean

true lubab 2FA ja nõuab otp, false keelab selle

Näide: true

otp_resetboolean

Väljastab uue 2FA saladuse; 2FA jääb välja lülitatuks kuni uue sidumiseni

Näide: false

otpstring

Praeguse saladuse kood; vajalik 2FA lubamisel ja otp_reset korral

Näide: 192870

Vastused

object

statusstringkohustuslik

Väärtused:successerror

Näide: success

dataobject

descriptionstring

Näide: Successfully saved

photostring

On olemas, kui avatar on asendatud

Näide: data:image/jpeg;base64,/9j/4AAQSkZJRg...

secretstring

On olemas, kui otp_reset

Näide: KA2G2UKBHBBHKOJR

qrstring

On olemas, kui otp_reset

Näide: 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

curl -X POST 'https://foodsoul.pro/api/crm/v2/profile.update' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: et' \
  -H 'role: affiliate' \
  -F 'name=John Smith' \
  -F 'phone_format_id=1' \
  -F 'phone_number=(952) 056-31-65' \
  -F 'telegram_user_id=476962294' \
  -F 'timezone=Europe/Kaliningrad' \
  -F 'language=ru' \
  -F 'photo=@file.jpg' \
  -F 'password=987654321' \
  -F 'old_password=123456789' \
  -F 'otp_enabled=true' \
  -F 'otp_reset=false' \
  -F 'otp=192870'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.pro/api/crm/v2/profile.update', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'et',
        'role' => 'affiliate',
    ],
    'multipart' => [
        [
            'name' => 'name',
            'contents' => 'John Smith',
        ],
        [
            'name' => 'phone_format_id',
            'contents' => '1',
        ],
        [
            'name' => 'phone_number',
            'contents' => '(952) 056-31-65',
        ],
        [
            'name' => 'telegram_user_id',
            'contents' => '476962294',
        ],
        [
            'name' => 'timezone',
            'contents' => 'Europe/Kaliningrad',
        ],
        [
            'name' => 'language',
            'contents' => 'ru',
        ],
        [
            'name' => 'photo',
            'contents' => '<file>',
        ],
        [
            'name' => 'password',
            'contents' => '987654321',
        ],
        [
            'name' => 'old_password',
            'contents' => '123456789',
        ],
        [
            'name' => 'otp_enabled',
            'contents' => 'true',
        ],
        [
            'name' => 'otp_reset',
            'contents' => 'false',
        ],
        [
            'name' => 'otp',
            'contents' => '192870',
        ],
    ],
]);

$data = json_decode((string) $response->getBody(), true);

const body = new FormData()
body.append("name", "John Smith")
body.append("phone_format_id", "1")
body.append("phone_number", "(952) 056-31-65")
body.append("telegram_user_id", "476962294")
body.append("timezone", "Europe/Kaliningrad")
body.append("language", "ru")
body.append("photo", "<file>")
body.append("password", "987654321")
body.append("old_password", "123456789")
body.append("otp_enabled", "true")
body.append("otp_reset", "false")
body.append("otp", "192870")

const response = await fetch("https://foodsoul.pro/api/crm/v2/profile.update", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "et",
        "role": "affiliate"
    },
    body,
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.pro/api/crm/v2/profile.update",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "et",
        "role": "affiliate",
    },
    files={
        "name": [
            None,
            "John Smith",
        ],
        "phone_format_id": [
            None,
            "1",
        ],
        "phone_number": [
            None,
            "(952) 056-31-65",
        ],
        "telegram_user_id": [
            None,
            "476962294",
        ],
        "timezone": [
            None,
            "Europe/Kaliningrad",
        ],
        "language": [
            None,
            "ru",
        ],
        "photo": [
            None,
            "<file>",
        ],
        "password": [
            None,
            "987654321",
        ],
        "old_password": [
            None,
            "123456789",
        ],
        "otp_enabled": [
            None,
            "true",
        ],
        "otp_reset": [
            None,
            "false",
        ],
        "otp": [
            None,
            "192870",
        ],
    },
)
data = response.json()

Vastus 200

{
  "status": "success",
  "data": {
    "description": "Successfully saved",
    "photo": "data:image/jpeg;base64,/9j/4AAQSkZJRg...",
    "secret": "KA2G2UKBHBBHKOJR",
    "qr": "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"
  }
}

Päringud saadetakse aadressile foodsoul.pro — see on selle portaali host, teist valida ei saa.

Salvesta profiili seaded

Autoriseerimine

Päringu keha multipart/form-data

Vastused

Päringu keha `multipart/form-data`