Статьи в этом разделе

Интеграция с личным кабинетом

Avatar
Mobium Support
Обновлено
Подписаться

Имеется возможность произвести интеграцию системы Mobium с личным кабинетом клиента, если такой имеется на сервере пользователя.

Методы:

 

Получение списка полей для регистрации

Осуществляется перед отображением экрана регистрации.

Пример запроса списка полей для регистрации

GET {regFields_url}

Данный запрос не может провалиться и возвращает JSON-объект следующего формата:

Пример ответа на запрос списка полей

{
  "status" : "ok",
  "data" : {
    "fields" : [
      {
        "id" : "name",
        "type" : "text",
        "title" : "ФИО",
        "required" : true
      },
      {
        "id" : "email",
        "type" : "email",
        "title" : "Электронная почта",
        "required" : true
      },
      {
        "id" : "password",
        "type" : "password",
        "title" : "Пароль",
        "required" : true
      }
    ]
  }
}

 

Название Описание
fields

   Массив, каждый объект которого описывает поле, доступное к заполнению при регистрации
id Уникальный идентификатор поля
type

Тип поля:

  • text — простое поле для ввода текста
  • password — поле для ввода пароля
  • email — поле для ввода адреса электронной почти
  • phone — поле для ввода телефона
  • number — поле для ввода числа
title Заголовок поля
required Обязательно ли данное поле к заполнению

 

Регистрация

Пример запроса регистрации

POST {registration_url}

{
    "appId":"appId",
    "platform":"platform",
    "locale":"locale",
    "field1":"value1",
    "field2":"value2",
    "field3":"value3",    
    "pushToken": "fahjkaslkh123hkjsdalkl",
    "regionId": "spb",
    "savedPhone": "+78885533",
    "savedEmail": "[email protected]"
}

 

Название
Описание
appId Уникальный идентификатор приложения пользователя
platform

Идентификатор платформы,ios/android
locale ISO (ru_RU,en_US,...)
pushToken Токен для push-уведомлений
regionId Идентификатор региона, выбранного пользователем
savedPhone Телефон, заполненный при оформлении заказа
savedEmail Электронная почта, заполненная при оформлении заказа

field1,

field2 ...

Значения полей, присланных для регистрации

В случае удачной регистрации происходит автоматически авторизация и возвращаемое значение аналогично оному при авторизации.

В случае неудачной регистрации возвращается следующий JSON-блок:

Пример ответа на неудавшийся запрос регистрации

{
  "status" : "error",
  "data" : {
    "errors" : [
      {
        "fieldId" : "id поля, в котором произошла ошибка",
        "errorMessage" : "текстовое описание ошибки"
      },
      {
        "fieldId" : "id другого поля, в котором произошла ошибка",
        "errorMessage" : "текстовое описание этой ошибки"
      }
    ]
  }
}
Название   Описание
errors  field_id Идентификатор поля
errorMessage Текст ошибки
 
Для всех таких действий определён особый тип ошибки на случай, если представленный accessToken не является валидным, не позволяет получить доступ к API:

Пример ответа на неудавшийся запрос

{
  "status" : "auth_error"
}
Если требуется верификация:
 

Пример ответа на неудавшийся запрос

{  
   "status":"verification_error",
   "data":{  
      "accessToken":"ключ, используемый для доступа к методам API",
      "fields":[  
         {  
            "time":120,
            "text":"информационный текст",
            "editable":true,
            "field_id":"идентификатор поля для верификации",
            "value":"значене поля"
         }
      ]
   }
}
Название Описание
status
  • error - ошибка в поле (-ях) необходимых для регистрации
  • auth_error - accessToken невалидный
  • verification_error - требуется обязательная верификация полей
  • verification - требуется верификация, но её можно пропустить
 accessToken Ключ, уникальный для каждой авторизации и используемый в связке с appId для получения доступа к методам API
fields time Время для обратного отсчета в секундах
text Текст для экрана верификации
editable Изменяемое ли поле
field_id Идентификатор поля
value Значение поля

 

Авторизация

Запросом является JSON-объект следующего формата:
 

Пример запроса на авторизацию по логину и паролю

POST {auth_url}
 
{
    "login":"login",
    "password":"password",
    "appId":"appId",
    "platform":"ios",
    "locale":"ru_RU",
    "pushToken": "fahjkaslkh123hkjsdalkl",
    "regionId": "spb",
    "savedPhone": "+78885533",
    "savedEmail": "[email protected]"
}

Пример запроса на авторизацию через соц. сети

POST {auth_url}
  {  
   "accessToken":"dvdxfbdfb",
   "type":"vkontakte",
   "internal_id":"id",
   "appId":"appId",
   "platform":"ios",
   "locale":"ru_RU",
   "pushToken":"fahjkaslkh123hkjsdalkl",
   "regionId":"spb",
   "savedPhone":"+78885533",
   "savedEmail":"[email protected]"
}

 

Название
Описание
login Логин пользователя
password Пароль пользователя
appId Уникальный идентификатор приложения пользователя
platform

Идентификатор платформы,ios/android
locale ISO (ru_RU,en_US,...)
pushToken Токен для push-уведомлений
regionId Идентификатор региона, выбранного пользователем
savedPhone Телефон, заполненный при оформлении заказа
savedEmail Электронная почта, заполненная при оформлении заказа
accessToken Ключ авторизации, полученный от соц сети
type

Название социальной сети:

  • vkontakte
  • ok
  • facebook
  • instagram
internal_id Идентификатор пользователя, полученный соц от сети (может не быть)

Ответом на запрос в случае успешной авторизации является JSON-объект следующего формата:

Пример ответа

{
  "status" : "ok",
  "data" : {
    "accessToken" : "ключ, используемый для доступа к методам API"
  }
}


В случае провалившейся авторизации возвращается JSON-объект следующего формата:

Пример ответа на неудавшийся запрос

{
  "status" : "error",
  "data" : {
    "errorMessage" : "Текстовое описание произошедшей ошибки"
  }
}

Пример ответа на запрос авторизации с необходимостью дальнейшей верификации

{  
   "status":"verification",
   "data":{  
      "accessToken":"ключ, используемый для доступа к методам API",
      "fields":[  
         {  
            "time":120,
            "text":"информационный текст",
            "editable":true,
            "field_id":"идентификатор поля для верификации",
            "value":"значене поля"
         }
      ]
   }
}

 

Название  Описание
status 
  • error - ошибка с текстовым полем
  • ok - успешная авторизация
  • verification_error - требуется обязательная верификация полей
  • verification - требуется верификация, но её можно пропустить
 accessToken  Ключ, уникальный для каждой авторизации и используемый в связке с appId для получения доступа к методам API
fields    time Время для обратного отсчета в секундах
text Текст для экрана верификации
editable Изменяемое ли поле
field_id Идентификатор поля
value Значение поля

 

Верификация

Пример запроса верификации 

POST {verification_url}
Authorization: accessToken
{  
   "code":"value",
   "field_id":"идентификатор поля",
   "value":"значение поля"
}

 

Название Описание
code Значение кода
field_id Идентификатор поля
value Новое значение поля
 

Пример ответа

{
  "status" : "ok"
}

Пример ответа на неудавшийся запрос

{
  "status" : "error",
  "data" : {
    "errorMessage" : "Текстовое описание произошедшей ошибки"
  }
}

 

Название  Описание
status 
  • error - ошибка с текстовым полем
  • ok - успешная авторизация

 

Повторное получение данных (смс, e-mail) для верификации

Получает новое смс (письмо) с кодом для верификации учётной записи.

Пример запроса повторного получения данных 

POST {verification_repeat_url}
Authorization: accessToken
{  
   "field_id":"идентификатор верифицируемого поля",
   "value":"значение поля"
}

 

Название Описание
field_id Идентификатор поля
value Новое значение поля

 

Возвращается объект следующего формата:

Пример ответа

{
  "status" : "ok"
}

Пример ответа на неудавшийся запрос

{
  "status" : "error",
  "data" : {
    "errorMessage" : "Текстовое описание произошедшей ошибки"
  }
}

 

Название  Описание
status 
  • error - ошибка с текстовым полем
  • ok - успешная авторизация

 

Обновление ключа авторизации

Отправляет новый ключ авторизации, при получении такого от соц сети.

Пример запроса повторного получения данных

POST {verification_repeat_url}
Authorization: accessToken
{  
   "accessToken":"новый ключ авторизации",
   "type":"facebook",
   "internal_id":"49539579"
}
Название
Описание
accessToken Ключ авторизации, полученный от соц сети
type

Название социальной сети:

  • vkontakte
  • ok
  • facebook
  • instagram
internal_id Идентификатор пользователя, полученный соц от сети (может не быть)

Возвращается объект следующего формата:

Пример ответа

{
  "status" : "ok"
}

 

Название  Описание
status 
  • ok - успешная авторизация

 

Выход

Происходит для уничтожения accessToken и отвязки устройства от учётной записи.

Пример запроса выхода 

DELETE {auth_url(MUST MATSH WITH POST METHOD)}
Authorization: accessToken

 

Получение списка полей для восстановления пароля

Осуществляется перед отображением экрана восстановления пароля.

Пример запроса списка полей для регистрации

GET {regFields_url}

Данный запрос не может провалиться и возвращает JSON-объект следующего формата:

Пример ответа на запрос списка полей

{
  "status" : "ok",
  "data" : {
    "fields" : [
      {
        "id" : "name",
        "type" : "text",
        "title" : "ФИО"
      },
      {
        "id" : "email",
        "type" : "email",
        "title" : "Электронная почта"
      }
    ]
  }
}

 

Название Описание
status
  • ok - успешная авторизация
fields   Массив, каждый объект которого описывает поле, доступное к заполнению при восстановлении пароля
id Уникальный идентификатор поля
type

Тип поля:

  • text — простое поле для ввода текста
  • email — поле для ввода адреса электронной почти
  • phone — поле для ввода телефона
title Заголовок поля

 

Восстановление пароля

Пример запроса восстановления пароля

POST {registration_url}

{
    "appId":"appId",
    "platform":"platform",
    "locale":"locale",
    "field1":"value1",
    "field2":"value2",
    "field3":"value3",    
    "pushToken": "fahjkaslkh123hkjsdalkl",
    "regionId": "spb"
}

 

Название
Описание
appId Уникальный идентификатор приложения пользователя
platform

Идентификатор платформы,ios/android
locale ISO (ru_RU,en_US,...)
pushToken Токен для push-уведомлений
regionId Идентификатор региона, выбранного пользователем

field1,

field2 ...

Значения полей, присланных для восстановления пароля

В случае удачного восстановления пароля выводится сообщение из ответа.

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

{
  "status": "ok",
  "data": {
    "message": "Письмо отправлено Вам на email! или другое сообщение для пользователя"
  }
} 

В случае не удачного восстановления пароля выводится сообщение из ответа.

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

{
  "status" : "error",
  "data" : {
    "errors" : [
      {
        "fieldId" : "id поля, в котором произошла ошибка",
        "errorMessage" : "текстовое описание ошибки"
      },
      {
        "fieldId" : "id другого поля, в котором произошла ошибка",
        "errorMessage" : "текстовое описание этой ошибки"
      }
    ]
  }
}

 

Название  Описание
status 
  • error - ошибка в поле (-ях) необходимых для восстановления пароля
errors field_id Идентификатор поля
errorMessage Текст ошибки

 

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

Получает информацию о пользователе.

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

GET {profile_url}
Authorization: accessToken

Возвращает блок следующего формата:

Пример ответа на запрос профиля

{  
   "status":"ok",
   "data":{  
      "name":"имя пользователя",
      "email":"адрес электронной почты пользователя",
      "phone":"номер телефона пользователя",
      "bonus":{  
         "amount":300.0,
         "available_proportion":0.2
      }
   }
}

 

Другой вариант ответа (кастомизируемый личный кабинет)

{  
   "status":"ok",
   "data":{  
      "fields":[  
         {  
            "type":"name_field",
            "editable":true,
            "field_id":"идентификатор поля",
            "value":"значение",
            "image":"https"
         },
         {  
            "type":"image_action_field",
            "action":{  
               "type":"openUrl",
               "param":"https"
            },
            "image":"https"
         },
         {  
            "type":"title_text_field",
            "time":2,
            "text":"информационный текст для окна верификации",
            "editable":true,
            "field_id":"идентификатор поля",
            "title":"заголовок",
            "value":"текущее значение",
            "need_verification":true,
            "verified":false
         },
         {  
            "type":"text_field",
            "value":"текст"
         },
         {  
            "type":"action_field",
            "action":{  
               "type":"openUrl",
               "param":"https"
            },
            "value":"текст",
            "image":"https"
         },
         {  
            "type":"bonus_field",
            "title":"заголовок",
            "value":"количество бонусов"
         },
         {  
            "type":"barcode_field",
            "image":"https"
         }
      ],
      "bonus":{  
         "amount":300.0,
         "available_proportion":0.2
      }
   }
}
Название  Описание
fields   Массив полей отображаемых на странице личного кабинета.
type

Тип поля. Поля будут отображены в переданном порядке.

  • name_field - поле с данными об имени
  • image_action_field - поле с изображением и действием
  • title_text_field - поле с заголовком и значением
  • text_field - поле с текстом
  • action_field - поле с действием
  • bonus_fields - поле с бонусами
  • barcode_field - поле для отображения штихкода
time Время для обратного отсчета в секундах (Необходимо, если поле может быть верифицировано).
text Текст для экрана верификации (Необходимо, если поле может быть верифицировано).
editable Изменяемое ли поле.
field_id Идентификатор поля.
title Название поля (используется как заголовок).
value Текущее значение поля.
need_verification Нужна ли верификация. Если значение false, следующий флаг не учитывается, но должен быть передан как false.
verified Верифицировано ли поле.
size Размер поля с типом separator
image Картинка для поля (опционально)

Объект bonus:

  • amount - количество доступных пользователю бонусов, число с точкой
  • available_proportion - какую часть заказа можно погасить баллами, число с плавающей точкой (20% - 0.2). Если отсутствует, то считается 1.0 (100%)

При наличии бонусов, при заказе появляется поле, позволяющее оплатить часть заказа бонусами.

 Объект Action:

  • type - тип действия
  • param - параметр для действия

Типы действия

ID Описание Описание параметра Параметр
openCategory Открыть категорию ID категории "id1572"
openCatalog Открыть каталог - -
openProduct Открыть товар ID товара "id1572"
openSearch Открыть поиск с запросом Текст запроса "Футболки"
openUrl Открыть url в приложении URL "https://google.com"
openUrlExternal Открыть url в браузере URL "https://google.com"
doCall Звонок на указанный номер Номер телефона "8 (800) 707-52-57"
openCart Открыть корзину - -
openMainScreen Открыть главный экран - - 
openShops Открыть адреса магазинов -  - 
openHistory Открыть историю заказов  - - 
openArticles Открыть новости  - - 
openFavourites Открыть избранное  - - 
openForm Открыть форму обратной связи  - - 
openGallery Открыть галерею  - - 
openProfile Открыть личный кабинет  - - 
openContent Открыть html файл   - - 
openMenu Открыть меню  - - 

 

Изменение полей

Изменяет поля, которые помечены флагом editable.

Пример запроса на изменение поля

POST {verification_change_url}
Authorization: accessToken
{  
   "fields":[  
      {  
         "field_id":"идентификатор поля",
         "value":"значение поля"
      },
      {  
         "field_id":"идентификатор поля",
         "value":"значение поля"
      }
   ]
}
Название Описание
field_id Идентификатор поля
value Новое значение поля

 

Пример ответа

{  
   "status":"ok"
}
 

Пример ответа на неудавшийся запрос

{
  "status" : "error",
  "data" : {
    "errorMessage" : "Текстовое описание произошедшей ошибки"
  }
}
Название  Описание
status 
  • error - ошибка с текстовым полем
  • ok - успешная авторизация

 

Получение списка заказов

Получает список идентификаторов заказов, связанных с данной учётной записью.

Пример запроса получения списка заказов 

GET {order_list_url}
Authorization: accessToken

Возвращается объект следующего формата:

Пример списка заказов

{
  "status" : "ok",
  "data" : {
    "orders" : [
      {
        "id" : "35454135",
        "status" : "оплачен",
        "total" : 1590,
        "deliveryType" : "самовывоз",
        "items" : [
          {
            "id" : "546543",
            "count" : 5,
            "price" : 582
          }
        ]
      }
    ]
  }
}

Order (заказ):

Название Описание
id уникальный идентификатор заказа
status статус заказа
total суммарная стоимость заказа
deliveryType тип доставки

Items (единица заказа):

Название Описание
id уникальный идентификатор товара
count количество товаров данного типа в заказе
price цена на момент заказа

 

Похожие статьи

Комментарии

0 комментариев

Статья закрыта для комментариев.