Skip to content
koltsov edited this page Jan 21, 2015 · 1 revision

Authenticate

Имя ресурса: /Authenticate

HTTP метод: POST

Параметры строки запроса:

  • login: имя учетной записи пользователя при авторизации по логину/паролю (может отсутствовать);

  • password: пароль учетной записи пользователя при авторизации по логину/паролю (обязателен при наличии параметра login);

В запросе должен присутствовать HTTP-заголовок Authorization с параметром ddauth_api_client_id (см. раздел Авторизация).

В случае, если авторизация производится по сертификату, в теле запроса должен содержаться X.509 сертификат пользователя, сериализованный в DER. В противном случае тело запроса должно быть пустым.

В случае успешного выполнения запроса, в теле ответа содержится авторизационный токен. Если авторизация производится по логину/паролю, тело ответа следует интерпретировать как строку в кодировке UTF-8. Если же авторизация производится по сертификату, то выдаваемый токен будет зашифрован в адрес пользовательского сертификата. В этом случае тело ответа следует интерпретировать как структуру CMS EnvelopedData в DER-кодировке.

Возможные HTTP-коды возврата:

  • 200 (OK) - операция успешно завершена;

  • 400 (Bad Request) - данные в запросе имеют неверный формат или отсутствуют обязательные параметры;

  • 401 (Unauthorized) - в запросе отсутствует HTTP-заголовок Authorization, или в этом заголовке отсутствует параметр ddauth_api_client_id, или переданный в нем ключ разработчика не зарегистрирован в Диадоке;

  • 405 (Method not allowed) - используется неподходящий HTTP-метод;

  • 500 (Internal server error) - при обработке запроса возникла непредвиденная ошибка.

HTTP API

История изменений Diadoc API Обзор возможностей API

Справочное руководство

Clone this wiki locally