Песочница
POST https://sandbox.alfabank.ru/api/jp/v3/signature/qes/requests/{Id}
Пром
POST https://baas.alfabank.ru/api/jp/v3/signature/qes/requests/{Id}
Scope
signature
Описание
Метод позволяет отправить на подпись заявку на подключение квалифицированной электронной подписи (КЭП).
Параметры запроса
HEADERS
Атрибут
Описание
Authorization
stringrequired
Возможны два варианта:
-
•Bearer {access_token}, полученный по Authorization Code Flow / Authorization Code Flow H2H
-
•ApiKey {API Key}, полученный через Портал разработчика
Accept
stringrequired
application/json
Content-Type
stringrequired
application/json
PATH
Атрибут
Описание
Id
stringrequired
Идентификатор заявки, полученный с помощью метода «Создание заявки на подключение КЭП»
BODY
Атрибут
Описание
requestType
stringrequired
Тип заявки. Принимает возможные значения:
-
•
enableQesSignType- заявка на подключение способа подписи КЭП
Пример запроса
Язык
1curl --location --globoff 'https://baas.alfabank.ru/api/jp/v3/signature/qes/requests/{Id}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data '{
6 "requestType": "enableQesSignType"
7}'
Параметры ответа
Пример ответа 200 (OK)
1{
2 "Id": "63160a37e27edd0c316567a6",
3 "requestType": "enableQesSignType",
4 "content": "eyJpZCI6IjY3ZjY2NDE3MmMyYjhhNjBmMTc1ZmQxNSIsInVzZXJJZCI6IlhDTFZSMiIsImNsaWVudElkIjoiVUMwUURHIiwiY3JlYXRvciI6eyJmaXJzdE5hbWUiOiLQn9C+0YLQsNC/IiwibGFzdE5hbWUiOiLQm9GD0LrQuNC9IiwicGF0cm9ueW1pY05hbWUiOiLQrdC70YzQtNCw0YDQvtCy0LjRhyJ9LCJ0eXBlIjoiZW5hYmxlUWVzU2lnbk1ldGhvZFJlcXVlc3QiLCJjcmVhdGVkRGF0ZSI6IjIwMjUtMDQtMDlUMTI6MTI6MDcuNjI1WiIsImRldGFpbHMiOnsiY2hhbm5lbCI6IndlYiJ9fQ=="
5}
BODY
атрибут
описание
Id
stringoptional
Идентификатор заявки
requestType
stringrequired
Тип заявки. Принимает возможные значения:
-
•
enableQesSignType- заявка на подключение способа подписи КЭП
content
stringrequired
Документ на подпись в формате base64
Пример ответа 200 (OK)
1{
2 "Id": "63160a37e27edd0c316567a6",
3 "requestType": "enableQesSignType",
4 "content": "eyJpZCI6IjY3ZjY2NDE3MmMyYjhhNjBmMTc1ZmQxNSIsInVzZXJJZCI6IlhDTFZSMiIsImNsaWVudElkIjoiVUMwUURHIiwiY3JlYXRvciI6eyJmaXJzdE5hbWUiOiLQn9C+0YLQsNC/IiwibGFzdE5hbWUiOiLQm9GD0LrQuNC9IiwicGF0cm9ueW1pY05hbWUiOiLQrdC70YzQtNCw0YDQvtCy0LjRhyJ9LCJ0eXBlIjoiZW5hYmxlUWVzU2lnbk1ldGhvZFJlcXVlc3QiLCJjcmVhdGVkRGF0ZSI6IjIwMjUtMDQtMDlUMTI6MTI6MDcuNjI1WiIsImRldGFpbHMiOnsiY2hhbm5lbCI6IndlYiJ9fQ=="
5}
BODY
атрибут
описание
error
stringrequired
Код ошибки. Принимает возможные значения:
-
•
invalid_request- неверные входные параметры запроса
error_description
stringrequired
Описание ошибки
Пример ошибки 400 (Bad Request)
1{
2 "error": "invalid_request",
3 "error_description": "Parameter 'sub' is not valid"
4}
BODY
атрибут
описание
error
stringrequired
Код ошибки. Принимает возможные значения:
-
•
invalid_token- предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам
error_description
stringrequired
Описание ошибки
Пример ошибки 401 (Unauthorized)
1{
2 "error": "invalid_token",
3 "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
4}
BODY
атрибут
описание
error
stringrequired
Код ошибки. Принимает возможные значения:
-
•
insufficient_scope- при запросе кода авторизации не были переданы все необходимые scopes. Необходимо переподписать договор согласия, повторно отправив запрос на получение кода авторизации с указанием всех доступных scopes и параметраprompt=consent
error_description
stringrequired
Описание ошибки
Пример ошибки 403 (Forbidden)
1{
2 "error": "insufficient_scope",
3 "error_description": "The request requires higher privileges than provided by the access token"
4}
Нет тела ответа
BODY
атрибут
описание
error
stringrequired
Код ошибки. Принимает возможные значения:
-
•
internal_error- внутренняя ошибка сервиса
error_description
stringrequired
Описание ошибки
Пример ошибки 500 (Internal Server Error)
1{
2 "error": "internal_error",
3 "error_description": "Internal server error"
4}
Нет тела ответа