Отправить пароль и начать новую сессию

Внимание

Новые ключи временно не выпускаются в связи с обновлением продукта.

Отправляет в систему Яндекс ОФД пароль, полученный в результате выполнения запроса Выслать пароль подписанту для начала новой сессии, и открывает новую сессию. Сессия длится два часа. В течение этого времени КСКПЭП имеет статус «active».

Формат запроса

POST https://api.ofd.yandex.net/{v1}/companies/{company_id}/signs/{sign_id}/session_password
  • v1
    Номер версии API ОФД.
  • company_id
    Идентификатор компании. Присваивается автоматически при регистрации компании в системе Яндекс ОФД.
  • sign_id
    Идентификатор КСКПЭП.

Заголовок запроса

Заголовки запроса должны содержать ключи (см. раздел Доступ к API):

Заголовок Значение
X-Yandex-Key <аутентификационный ключ>
X-OFD-Key <авторизационный ключ>
Content-Type application/json

Тело запроса

{
  "password": "{string}"
}

* Обязательный параметр.

Формат ответа

Если запрос выполнен успешно, сервер возвращает HTTP-статус выполнения операции: «204 No Content».

В случае возникновения ошибок при обработке запроса ответ сервера содержит код и описание ошибки.

Коды ответа

Список кодов, которые поддерживаются в API ОФД см. в разделе Коды ответов и ошибки.

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

Метод и адрес:

POST https://api.ofd.yandex.net/v1/companies//693/signs/245/session_password

Заголовки:

x-yandex-key: 74f...e8ca
x-ofd-key: eka...b17eae
Content-Type: application/json

Тело:

{
  "password": "371595"
}
Пример запроса в формате cURL
curl -X POST \
  https://api.ofd.yandex.net/v1/companies/693/signs/245/session_password \
  -H 'Content-Type: application/json' \
  -H 'x-ofd-key: eka...b17eae' \
  -H 'x-yandex-key: 74f...e8ca' \
  -d '{
  "password": "371595"
}'