Аккаунт

/api/lite/pub/register

Создание нового аккаунта Кактус Lite 

/api/lite/pub/register

Для регистрации необходимо выполнить следующий запрос

{
   "account":{
      "email":"test@test.ru",
      "phone":"123456",
	  
      "type":"abc" // опциональный параметр кода учетной записи
   }
}

В ответ возвращается 

Успех

возвращается jwt токен для доступа в админский api созданного аккаунта, после чего необходимо выполнить запрос инициализации аккаунта (/api/lite/registration_init)

{
"success": true,
"authToken": {
"access_token": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhYmNkNTRAYWJjLnJ1IiwiZXhwIjoxNTQ3MjIyOTYwfQ.3NkyrZshkAYJWpIvanKuVv5I5Lqh7gCAojszBys9tOnqOdIpTDm5tCDzDWIt71YuxLBCgwlmC5OiH1Sombp2Hg",
"token_type": "bearer",
"login": "abcd54@abc.ru",
"expires_in": 14400,

"init_state": "0"
}
}

Ошибка

{
"success": false,
"errors": [
 {
 "code": 0,
 "message": "Текст ошибки"
 }
]
}

/api/lite/pub/email/quote

Отправка email с заявкой на консультацию через бэкенд

/api/lite/pub/email/quote

Отправка письма с заявкой на консультацию. 

Защи/api/lite/pub/email/quщено с помощью reCaptcha (пока не реализовано)

Пример запроса:

{
"customerName":"Вася",
"customerPhone": "123456",
"customerEmail":"test@test.ru",
"title":"Заявка на консультацию",
"message":"Мне ничего не понятно, помогите"
}

Пример успешного ответа:

{
"success": true
}

Пример ошибки:

{
"success": false,
"errors": [
{
"code": 0,
"message": "Email не валиден"
}
]
}

/api/lite/registration_init

Инициализация нового аккаунта Кактус Lite

/api/lite/registration_init

Для инициализации и заполнения аккаунта начальными данными необходимо выполнить указанный запрос

В ответ возвращается

Успех:

{

"success": true

}

Ошибка:

{
"success": false,
"errors": [
{
"code": 0,
"message": "Данный аккаунт уже инициализирован"
}
]
}

/api/lite/pub/password_reset

Запрос на сброс пароля Кактус Lite

/api/lite/pub/password_reset

Для запроса сброса необходимо выполнить следующий запрос:

{ 
    "email":"test@test.ru"   
}

В ответ возвращается

Успех:

{

"success": true

}

при этом, по указанному email отправляется письмо со ссылкой вида

http://localhost:33043/password_reset_confirm/?t=6aaccd91-1045-4200-b105-b4db79490fee

Где адрес сервера будет взят из текущего адреса, включая домен 3 уровня.

срок действия токена - 1 час

Данная ссылка будет открыта пользователем в браузере GET запросом. 

js код должен обработать открытие подобной ссылки и вывести пользователю запрос на ввод нового пароля и подтверждение пароля.

По нажатию кнопки подтверждения на данном экране создания нового пароля следует выполнить POST запрос на адрес /api/lite/pub/password_reset_confirm с передачей токена из ссылки и нового пароля  (см следующий метод).

Ошибка: 

{
"success": false,
"errors": [
 {
 "code": 0,
 "message": "Текст ошибки"
 }
]
}

/api/lite/pub/password_reset_confirm

Сброс пароля 

/api/lite/pub/password_reset_confirm

Для сброса необходимо выполнить запрос с передачей временного токена сброса пароля и нового пароля:

{ 
    "token":"6aaccd91-1045-4200-b105-b4db79490fee",

    "password": "abcd"
}

В ответ возвращается

Успех:

{

"success": true

}

Ошибка: 

{
"success": false,
"errors": [
 {
 "code": 0,
 "message": "Текст ошибки"
 }
]
}

/api/lite/notifications

Перечень уведомлений для пользователя

/api/lite/notifications

Возвращает перечень сообщений для пользователя.

По умолчанию, возвращается с указанным количеством (last_count), начиная от самого последнего.

Запрос:

Параметр Тип / формат Описание
last_count integer Количество сообщений

Пример запроса:

{
    "last_count":10
}

Результат запроса:

Параметр Тип / формат Описание
notifications array Массив уведомлений

Пример результата запроса:

{
    "success": true,
    "notifications": [
        {
            "date":"2019-01-09T20:00:02",
            "text":"Уведомление 1"
        },
        {
            "date":"2019-01-09T20:00:01",
            "text":"Уведомление 2"
        }
    ]
}

/api/lite/account_info

Запрос данных аккаунта

/api/lite/account_info

Метод возвращает информацию о текущем аккаунте.

Параметр Тип / формат Описание

login

string

Логин пользователя

domains

array[object]

Массив доменов, связанных с аккаунтом

  • domain - домен 3 уровня

  • auto_generated - флаг, что домен автосоздан при регистрации

balance

object

Информация о балансе:

  • total - общий остаток на счете

  • reserved - заблокированная сумма

  • available - доступный остаток

billingBalance

object

Информация о балансе (биллинг):

  • total - общий баланс / задолженность
  • expired - просроченная задолженность

pickupSettings

object

Настройки точки сбора (см описание метода /api/lite/settings/pickup)

b2bFlagAllowed

boolean

Настройка для выгрузки B2B заказов -- если true, то в заказе появится галка "B2B заказ"
*Настройка для B2B включается по запросу клиента; по умолчанию не используется.

Пример результата запроса:

{
  "success": true,
  "login": "tatiana.bogatel@theroadwear.com",
  "domains": [
    {
      "domain": "shop2151264",
      "auto_generated": true,
      "external_domain": false
    },
    {
      "domain": "theroadwear",
      "auto_generated": false,
      "external_domain": false
    }
  ],
  "balance": {
    "total": 0,
    "reserved": 0,
    "available": 0
  },
  "billingBalance": {
    "total": -79446.00,
    "expired": -2000.00
  },
  "pickupSettings": {
    "person_full_name": "Фарид",
    "person_phone": "+79999999999",
    "address": {
      "country": "Россия",
      "countryCode": "RU",
      "region": "Московская область",
      "area": "Чеховский район",
      "city": "Чехов",
      "settlement": "сельское поселение Баранцевское, в районе деревни Лешино, пром. зона «Лешино»",
      "street": "",
      "house": "владение 1",
      "block": "",
      "building": "СТРОЕНИЕ 1",
      "flat": null,
      "fullAddress": "142326, РФ, Московская область, Чеховский район, сельское поселение Баранцевское, в районе деревни Лешино, промышленная зона «Лешино», владение 1, строение 1",
      "fullCity": null,
      "rawData": null,
      "zip": "142326",
      "regionFias": "29251dcf-00a1-4e34-98d4-5c47484a36d4",
      "areaFias": null,
      "cityFias": "7eeb876e-7b67-4ed7-91ec-0588712db96c",
      "settlementFias": "5f12f12b-42b3-4f89-b214-d8ab9c10e9f8"
    }
  },
  "shopId": "2151264",
  "shopName": "ООО «Роуд Продакшн»",
  "orderSummary": {
    "DELIVERED": 24,
    "RETURNED": 2,
    "CANCELED": 62
  },
  "autoBlockAccount":true,
  "tempBlockAccount":true,
  "tempBlockAccountReason":"Временно заблокирован"
}

Ошибка: 

{
"success": false,
"errors": [
 {
 "code": 0,
 "message": "Текст ошибки"
 }
]
}

/api/lite/privileges

Запрос текущих привилегий

/api/lite/privileges

Метод возвращает список текущих привилегий авторизованного пользователя

Пример результата запроса:

{
    "privileges": [
      "DASHBOARD_DATA_READ", 
      "SETTINGS_READ", 
      "ORDERS_READ"
    ]
}