API.Картотека
8 (800) 100-85-50
Звонок по России бесплатный!
Внимание!
Сообщаем Вам о прекращении поддержки API версии 1.0. Версия API 2.0 с 01.01.2016 более не обновляется и в будущем её поддержка может быть прекращена после соответствующего уведомления, рекомендуем пользоваться новой версией API 3.0.

Метод login

Краткое описание

Метод предназначен для выполнения авторизации c помощью логина и пароля сайта http://www.kartoteka.ru/ и получения идентификатора сессии.

Входные параметры:

  • данные для аутентификации (передается в теле SOAP-запроса).

Выходные параметры

  • сессия.

Шаблон SOAP-запроса


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"      xmlns:v1="http://api.kartoteka.ru/auth/v1/">
    <soapenv:Header/>
    <soapenv:Body>
       <v1:login>
          <authRequest>
             <!-- данные для аутентификации -->
          </authRequest>
       </v1:login>
    </soapenv:Body>
 </soapenv:Envelope> 

Шаблон SOAP-ответа


<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://api.kartoteka.ru/auth/v1/">
    <SOAP-ENV:Body>
       <SOAP-ENV:loginResponse>
          <authResponse>
             <!-- идентификатор сессии -->
          </authResponse>
       </SOAP-ENV:loginResponse>
    </SOAP-ENV:Body>
 </SOAP-ENV:Envelope>

Входные параметры

Данные для аутентификации

Ниже находится описание формата данных для аутентификации (Рис. 2.1.2.1.1 ).

формат данных для аутентификации
Рис. 2.1.2.1.1 . Формат данных для аутентификации

Таблица 2.1.2.1.1. Состав и структура запроса (login)

Наименование элемента Сокращённое наименование (код) элемента Признак типа элемента Формат элемента Признак обязательности элемента Дополнительная информация
Логин login П T О
Пароль password П T О

Выходные параметры

Сессия

Ниже находится описание формата сессии (Рис. 2.1.2.1.2 ).
Формат сессии
Рис. 2.1.2.1.2 . Формат сессии

Таблица 2.1.2.1.2. Состав и структура типового элемента (authResponse)

Наименование элемента Сокращённое наименование (код) элемента Признак типа элемента Формат элемента Признак обязательности элемента Дополнительная информация
Информация о сессии session С О Типовой элемент (session) (Таблица 2.1.2.1.3 )

Таблица 2.1.2.1.3 . Состав и структура типового элемента (session)

Наименование элемента Сокращённое наименование (код) элемента Признак типа элемента Формат элемента Признак обязательности элемента Дополнительная информация
Идентификатор сессии id П T О

Примеры

Пример №1

Авторизоваться под учетными данными логин: search_api_demo, пароль: search_api_demo и получить идентификатор сессии.

SOAP-запрос:

POST /auth/v1/soap/ HTTP/1.1
Content-Type: text/xml;charset=UTF-8
SOAPAction: "Auth#login"
Content-Length: 379
Host: api.kartoteka.ru

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://api.kartoteka.ru/auth/v1/">
    <soapenv:Header/>
    <soapenv:Body>
       <v1:login>
          <loginRequest>
             <login>search_api_demo</login>
             <password>search_api_demo</password>
          </loginRequest>
       </v1:login>
    </soapenv:Body>
 </soapenv:Envelope> 

SOAP-ответ:
  
 <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://api.kartoteka.ru/auth/v1/">
   <SOAP-ENV:Body>
      <ns1:loginResponse>
         <loginResult>
            <session>
               <id>61q0pdiaclaedo99gurm386sc2</id>
            </session>
         </loginResult>
      </ns1:loginResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Печать