Методы API. Аутентификация

Аутентификация

Для авторизации по API требуется в начале XML-запроса указать URL аккаунта (account-name.maxoptra.com), имя пользователя и пароль. URL - это путь к аккаунту, который можно найти в адресной строке в браузере при работе с аккаунтом. Имя пользователя - это логин пользователя, имеющего доступ по API, находится на закладке Пользователи. Следует отметить, что только пользователь с ролью Администратор Аккаунта может предоставить доступ пользователю к API-функционалу.

createSession

Запрос createSession

Для запроса авторизации по API используется структура запроса application/x-www-form-urlencoded и HTTP-метод POST.

Входные данные запроса createSession

Входные данные запроса авторизации должны отправляться в виде атрибутов и не должны быть включены в тело запроса. Список поддерживаемых атрибутов и их описание приведены ниже.

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

Заголовки:

URL: [account-name].maxoptra.com/rest/2/authentication/createSession?accountID=demo&user=demo.dispatcher&password=123

Метод: POST

Структура запроса: application/x-www-form-urlencoded

Тело запроса: не должно содержать никакой информации

Ответ createSession

В текущем решении API для предоставления ответа используется application/xml структура.

Выходные данные ответа createSession

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

<?xml version="1.0" encoding="UTF-8"?>
<apiResponse version="2.0">
   <authResponse>
      <sessionID>8aa519d2c0af4f37a27a42a995528199</sessionID>
   </authResponse>
</apiResponse>

См. также

Пользователи

REST API