Поиск по сайту

API
Главная / API - Авторизация пользователя

Авторизация пользователя

Обновлено 18.01.2022
Скачать в PDF
142 кб
Содержание:

Общие сведения

Сервис позволяет осуществить следующие операции:

  • авторизовать пользователя;
  • закрыть текущую сессию для пользовательской авторизации;
  • получить данные текущей сессии.

Авторизация пользователя 

Запрос метода

Структура запроса

Адрес метода: https://api.dellin.ru/v3/auth/login.json

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "login":"info@info.ru",
   "password":"Password1"
}

Адрес метода: https://api.dellin.ru/v3/auth/login.xml 

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <login>info@info.ru</login>
   <password>Password1</password>
</request>

Описание параметров

Request
Request
ПараметрОбязательныйТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию
loginДаstring

Логин от Личного кабинета (1).

В качестве логина можно использовать как email, так и номер телефона.

Формат номера телефона: "+7XXXXXXXXXX" - 12 символов, начиная с "+7"

passwordДаstringПароль от Личного кабинета (1)

Примечания:

  1. Чтобы получить логин и пароль, пользователю следует зарегистрироваться на сайте компании "Деловые Линии"

Ответ метода

Структура ответа

{
   "metadata":{
      "status":200,
      "generated_at":"2015-06-18 12:37:28"
   },
   "data":{
      "sessionID":"00000000-0000-0000-0000-000000000000"
   }
}
<response>
   <metadata>
      <status>200</status>
      <generated_at>2015-06-18 12:37:28</generated_at>
   </metadata>
   <data>
      <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   </data>
</response>

Описание параметров

Response
Response
ПараметрТипОписание
metadataobjectСистемная информация
metadata.statusintegerЭмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" (OK)
metadata.generated_atstring

Дата и время генерации ответа сервера.

Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС"

dataobjectДанные сессии
data.sessionIDstringID сессии для запросов к данным Личного кабинета

Обработка ошибок

В методе используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".

Удаление сессии авторизации

Запрос метода

Структура запроса

Адрес метода: https://api.dellin.ru/v3/auth/logout.json 

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000"
}

Адрес метода: https://api.dellin.ru/v3/auth/logout.xml 

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
</request>

Описание параметров

Request
Request
ПараметрОбязательныйТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию
sessionIDДаstringID сессии для запросов к данным Личного кабинета

Ответ метода

Структура ответа

{
   "metadata":{
      "status":200,
      "generated_at":"2015-06-18 12:37:28"
   },
   "data":{
      "state":"success"
   }
}
<response>
   <metadata>
      <status>200</status>
      <generated_at>2015-06-18 12:37:28</generated_at>
   </metadata>
   <data>
      <state>success</state>
   </data>
</response>

Описание параметров

Response
Response
ПараметрТипОписание
metadataobjectСистемная информация
metadata.statusintegerЭмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" (OK)
metadata.generated_atstring

Дата и время генерации ответа сервера.

Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС"

dataobjectПодтверждение успешности операции
data.statestringСтатус обработки запроса. Возможное значение - "success" (операция успешно завершена)

Обработка ошибок

В методе используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".

Данные сессии

Отслеживание состояния текущей сессии можно использовать для предварительного возобновления сессии перед отправкой запроса к API Личного Кабинета.

Запрос метода

Структура запроса

Адрес метода: https://api.dellin.ru/v3/auth/session_info.json 

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000"
}

Адрес метода: https://api.dellin.ru/v3/auth/session_info.xml  

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionid>00000000-0000-0000-0000-000000000000</sessionid>
</request>

Описание параметров

Request
Request
ПараметрОбязательныйТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию
sessionIDДаstringID сессии для запросов к данным Личного кабинета

Ответ метода

Структура ответа

{
   "metadata":{
      "status":200,
      "generated_at":"2015-06-18 12:37:28"
   },
   "data":{
      "session":{
         "expireTime":"2014-04-12 18:01",
         "expired":false
      }
   }
}
<response>
   <metadata>
      <status>200</status>
      <generated_at>2015-06-18 12:37:28</generated_at>
   </metadata>
   <data>
      <session>
         <expireTime>2014-04-12 18:01</expireTime>
         <expired>false</expired>
      </session>
   </data>
</response>

Описание параметров

Response
Response
ПараметрТипОписание
metadataobjectСистемная информация
metadata.statusintegerЭмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" (OK)
metadata.generated_atstring

Дата и время генерации ответа сервера.

Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС"

dataDataДанные сессии

Data

Data

ПараметрТипОписание
sessionobjectДанные текущей сессии
session.expireTimestring

Дата окончания действия сессии. Если сессия истекла, то значение параметра - null.

Формат: "ГГГГ-ММ-ДД ЧЧ:ММ"

session.expiredboolean

Состояние сессии.

Возможные значения:

  • "false" - сессия активна;
  • "true" - сессия истекла

Обработка ошибок

В методе используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".