Получение статуса запроса на новый сертификат

Обновлено 29 ноября 2024

/fintech/api/v1/crypto/cert-requests/{externalId}/state

Ресурс позволяет получить информацию по статусу запроса на новый сертификат. Полученную информацию возможно использовать для контроля и анализа статуса запроса на новый сертификат. Работает только с access_token сотрудников вашей компании.

Для получения статуса заявления необходимо отправить GET-запрос /fintech/api/v1/crypto/cert-requests/{externalId}/state с токеном доступа (access_token) пользователя вашей компании в параметре Authorization заголовка и идентификатором документа (externalId) в path-параметре.

В параметре scope ссылки авторизации пользователя вашей компании должен быть указан сервис CERTIFICATE_REQUEST для получения доступа к этому ресурсу.

Для обращения к ресурсу необходимо отправлять запрос на:

Тестовый контур https://iftfintech.testsbi.sberbank.ru:9443
Промышленный контур https://fintech.sberbank.ru:9443

Request

/fintech/api/v1/crypto/cert-requests/{externalId}/state

Модель
Пример

Наименование	Тип	Формат	Regexp	Обязательность	Описание
HEADER
Authorization	string	string	^[a-zA-Z0-9]{38}$	required	Access token пользователя, полученный через SSO.
PATH-PARAMETERS
externalId	string	UUID	^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$	required	Идентификатор документа, присвоенный вами,

GET /fintech/api/v1/crypto/cert-requests/dab8ecab-b35f-4234-9daa-07fc349f940e/state HTTP/1.1
Authorization: Bearer f8b476b0e95e4ad2b3ec122fbf331444276b0e

Responses

200 (OK)

Модель
Пример

Наименование	Тип	Обязательность	Описание
AcceptanceAdvance {
bankComment	string	optional	Расшифровка статуса обработки,
bankStatus	string	optional	Статус обработки,
channelInfo	string	optional	Комментарий, специфичный для документа, полученного по данному каналу
}

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
 
{
    "bankStatus": "ACCEPTED",
    "bankComment": "Public Key DS: 19eb2bf9c7720db5297b7a9566132c25e29cc3fa16bf94b5999213f292ff500c\naf673a97cf026d57e58e8303215eea3220a9d342fff02ebebd20e32be2c27825\n TLS: null",
    "channelInfo": null
}

400 (Bad request)

Cause	Message	Description
DESERIALIZATION_FAULT	Неверный формат запроса	Данные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в responce в массиве fields с описанием проблемы. Описание типа, формата и regexp атрибутов находится в request метода. Скорректируйте заполнение атрибутов и повторите запрос.

Модель
Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор,
message	string	optional	Сообщение
}

HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8

{
    "cause": "WORKFLOW_FAULT",
    "referenceId": "6a2489c7-b65f-4ffa-a3cc-0e66dc86a49c",
    "message": "Параметр \"externalId\" не соответствует регулярному выражению: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}",
    "checks": [],
    "fieldNames": null
}

401 (Unauthorized Error)

Cause	Message	Description
UNAUTHORIZED	accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х	Указан некорректный или просроченный access_token. Используйте refresh_token для обновления access_token и повторите запрос.

Модель
Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор,
message	string	optional	Сообщение
}

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8

{
    "cause": "UNAUTHORIZED",
    "referenceId": "014ec3a1-3e41-4805-9e22-d07947b012af",
    "message": "accessToken not found by value = 3513f959-bbd5-490a-9f9f-67fb7380fae5-2"
}

403 (Forbidden)

Cause	Message	Description
ACTION_ACCESS_EXCEPTION	Операция не может быть выполнена: доступ к ресурсу запрещен	Используемый в запросе access_token не имеет разрешения на доступ к нужному сервису Sber API. В ссылке авторизации СберБизнес ID, в параметре scope, не указана операция `CERTIFICATE_REQUEST`. Необходимо добавить эту операцию в scope. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.
ACCESS_EXCEPTION	Работа с сертификатами и криптопрофилями доступна только по собственной организации	Используемый в запросе access_token принадлежит пользователю, который не является сотрудником вашей компании. Для работы с пользователями других компании используйте ресурсы группы `/v1/crypto.../eio`

Модель
Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор,
message	string	optional	Сообщение
}

HTTP/1.1 403 Forbidden
Content-Type: application/json;charset=UTF-8

{
    "cause": "ACCESS_EXCEPTION",
    "referenceId": "a29eb2c1-ab5b-4391-b99b-fa39e595394f",
    "message": "Работа с сертификатами и криптопрофилями доступна только по собственной организации"
}

429 (Too Many Requests)

Cause	Message	Description
TOO_MANY_REQUESTS	Превышен лимит запросов. Повторите операцию позже.	Количество запросов к данному методу за ограниченное время превысило допустимое значение. Пользователю необходимо повторить запрос позднее

Модель
Пример

Наименование	Тип	Обязательность	Описание
Notice{
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

500 (Internal Server Error)

Cause	Message	Description
UNKNOWN_EXCEPTION	Внутренняя ошибка сервера	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.

Модель
Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор,
message	string	optional	Сообщение
}

HTTP/1.1 500 Internal Server Error
Content-Type: application/json;charset=UTF-8

{
    "cause": "UNKNOWN_EXCEPTION",
    "referenceId": "9e209109-4b0d-408c-a2fd-e1983c20a65d",
    "message": "Внутренняя ошибка сервера"
}

Статусы заявления

bankStatus (string)

Код состояние документа	Наименование статуса	Назначение кода состояния
Промежуточный/Продолжать опрашивать
`CREATED`	Создан	Документ записан в БД, проверки не выполнялись
`ACCEPTED`	Принят	Электронный документ принят на стороне Банка
`ACCEPTED_BY_ABS`	Принят АБС	Электронный документ был принят к обработке в АБС Банка Подписанту необходимо предоставить в Банк заявление на выпуск сертификата. С помощью ресурса GET `/fintech/api/v1/crypto/cert-requests/{externalId}/print` получите печатную форму заявления, распечатайте и подпишите. Далее Подписанту необходимо педоставить заявление в обслуживающий офис Сбера.
`PUBLISHED_BY_BANK`	Издан Банком	Сертификат выпущен, и него необходимо активировать. Активировать сертификат можно с помощью ресурса POST `/fintech/api/v1/crypto/cert-requests/{externalId}/activate`
Окончательный (Не успешный)/Прекратить опрос
`DENIED`	Отказано в сертификации	Ошибка в процессе выпуска сертификата либо отказано в сертификации
Окончательный (Успешный)/Прекратить опрос
`PROCESSED`	Обработан	Сертификат активирован

Получение статуса запроса на новый сертификат

Статусы заявления﻿

Статусы заявления