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

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

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

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

Действия, не требующие авторизации

Авторизация

Пример запроса авторизации
POST {auth_url}
 
{
    "login":"login",
    "password":"password",
    "appId":"appId",
    "platform":"ios",
    "locale":"ru_RU",
    "pushToken": "fahjkaslkh123hkjsdalkl",
    "regionId": "spb",
    "savedPhone": "+78885533",
    "savedEmail": "example@example.com"
}

Поля имеют следующие назначения:

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

platform

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

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

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

Поля имеют следующие назначения:

Название
Описание
accessToken Ключ, уникальный для каждой авторизации и используемый в связке с appId для получения доступа к методам API


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

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

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

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

Пример запроса списка полей для регистрации
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": "example@example.com"
}

Полями запроса являются уникальный идентификатор приложения, а также все поля, указанные при регистрации в приложении, с их введёнными значениями. К примеру, name=abc&password=12345&email=a@a.a

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

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

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

Действия, требующие авторизацию

Для всех таких действий определён особый тип ошибки на случай, если представленный accessToken не является вылидным не позволяет получить доступ к API:

Пример ответа на неудавшийся запрос
{
  "status" : "auth_error"
}

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

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

Пример запроса получения списка заказовat
 
GET {order_list_url}
Authorization: accessToken

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

Пример списка заказов
{
  "status" : "ok",
  "data" : {
    "orders" : [
      {
        "id" : "уникальный идентификатор заказа",
        "status" : "статус заказа",
        "total" : суммарная стоимость заказа,
        "deliveryType" : "тип доставки",
        "items" : [
          {
            "id" : уникальный идентификатор товара,
            "count" : количество товаров данного типа в заказе,
            "price" : цена на момент заказа
          }
        ]
      }
    ]
  }
}
 
Order (заказ):
id Строка
status Строка
total Число с точкой
deliveryType Строка 

Order (заказ):
id Строка
count Целое число
price Число с точкой

 

Выход

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

Пример запроса выхода
 
DELETE {auth_url(MUST MATSH WITH POST METHOD)}
Authorization: accessToken

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

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

Пример запроса получения сведений о профиле
GET {profile_url}
Authorization: accessToken

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

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

Объект bonus:

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

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

 

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

Комментарии

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

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