Client Secret – это пароль который увеличивает безопасность передачи данных вашей интеграции. Поддержка Сбера сообщает подробности о Client Secret контактному лицу вашей организации при заключении договора.
Срок действия Client Secret составляет 40 дней с даты выпуска. Чтобы интеграцию не заблокировали, обновляйте Client Secret заранее до истечения срока. Банк отправляет уведомления за 5 дней до окончания действия на элекронный адрес, указанный в заявлении на подключение к Sber API.
Обновить Client Secret можно также в Личном кабинете Sber API.
/ic/sso/api/v1/change-client-secret
Запрос позволяет обновить Client Secret вашей интеграции. В запросе необходимо передавать токен доступа (access_token) Пользователя собственной организации.
Для обращения к ресурсу необходимо отправлять запрос на:
- Тестовый контур
https://iftfintech.testsbi.sberbank.ru:9443 - Промышленный контур
https://fintech.sberbank.ru:9443
Request
/ic/sso/api/v1/change-client-secret
- Модель
- Пример
| Наименование | Тип | Формат | Regexp | Обязательность | Описание |
|---|---|---|---|---|---|
| QUERRY PARAMETERS | |||||
| access_token | string | UUID | ^[a-zA-Z0-9]{38}$ | required | Access token пользователя, полученный через SSO. |
| client_id | string | string | ^[a-zA-Z0-9]+$ | optional | Указывается идентификатор Платформы (client_id), для которого необходимо изменить client_secret. Если client_id не указан, то будет изменен client_secret приложения, для которого выдан access_token. |
| client_secret | string | string | ^[a-zA-Z0-9]{8,256}$ | required | Пароль вашей Платформы. Вы его впервые получаете при подключении к Sber API и в последующем периодически обновляете. |
| new_client_secret | string | string | ^[a-zA-Z0-9]{8,256}$ | required | Новое значение client_secret Плафтормы, для которого необходимо изменить client_secret |
POST /ic/sso/api/v1/change-client-secret?access_token=xbgKDVrgf756ghi789jk452DmaNKFtEpdqr678&client_id=9223567396&client_secret=vyY12PXdET&new_client_secret=vyY13PX12d1
Responses
200 (ОК)
- Модель
- Пример
| Наименование | Тип | Обязательность | Описание |
|---|---|---|---|
| clientSecretExpiration | number | optional | Срок действия нового Client Secret (в днях) |
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"clientSecretExpiration": 40
}
400 (Bad request)
| error | error_description | Описание причины |
|---|---|---|
| Передано некорректное значение нового client secret: '{0}' | Значение нового Client Secret совпадает с текущим или не прошло валидацию на допустимый размер значения | |
| Передано некорректное значение действующего client secret: '{0}' | Значение переданное в параметре client_secret не совпадает со значением указанным для client_id | |
| invalid_grant | Parameter 'access_token' is required at request | В запросе не был передан access_token пользователя вашей компании |
- Модель
- Пример
| Наименование | Тип | Обязательность | Описание |
|---|---|---|---|
| { | |||
| error | string | required | Ошибка запроса |
| error_description | string | optional | Описание ошибки |
| } |
HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8
{
"error": "Передано некорректное значение нового client secret: 'vyYPX1dET'"
}
401 (Unauthorized Error)
| error | Описание причины |
|---|---|
| UNAUTHORIZED | Переданный токен не найден. Например, потому что пользователь отозвал согласие на передачу данных |
- Модель
- Пример
| Наименование | Тип | Обязательность | Описание |
|---|---|---|---|
| { | |||
| error | string | required | Ошибка запроса |
| } |
HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8
{
"error": "UNAUTHORIZED"
}
403 (Forbidden)
| error | Описание причины |
|---|---|
| Изменение client secret недоступно | Для данного типа Платформы использование ресурса /change-client-secret недоступно |
| Client secret просрочен | Срок действия текущего Client Secret истек. Для обновления Client Secret обратитесь воспользуйтесь соответствующей функциональностью Личного кабинета (если есть доступ) или в техническую поддержку Банка. |
| Попытка изменения client secret при помощи access token, выданного пользователем, не принадлежащим организации, предоставляющей услуги внешнего сервиса | Access Token выдан пользователем, не принадлежащим организации владельцу Платформы |
| Попытка изменения client secret внешнему сервису, организация которого отличается от организации пользователя, выдавшего access token | Параметр client_id указан и организация владельца Access Token не совпадает с организацией владельца Платформы, чей client_id указан |
- Модель
- Пример
| Наименование | Тип | Обязательность | Описание |
|---|---|---|---|
| { | |||
| error | string | required | Ошибка запроса |
| } |
HTTP/1.1 403 Forbidden
Content-Type: application/json;charset=UTF-8
{
"error": "Попытка изменения client secret при помощи access token, выданного пользователем, не принадлежащим организации, предоставляющей услуги внешнего сервиса"
}
406 (Not acceptable)
| error | Описание причины |
|---|---|
| SSOREQUESTED_FORMAT_NOT_ACCEPTABLE_EXCEPTION | Для Платформы установлен запрет на прием запросов с http-заголовком Accept со значением application/jose |
| SSOREQUESTED_FORMAT_NOT_ACCEPTABLE_EXCEPTION | Для Платформы установлен запрет на прием запросов с http-заголовком Accept со значением application/json |
- Модель
- Пример
| Наименование | Тип | Обязательность | Описание |
|---|---|---|---|
| { | |||
| error | string | required | Ошибка запроса |
| } |
HTTP/1.1 406 Not acceptable
Content-Type: application/json;charset=UTF-8
{
"error": "SSOREQUESTED_FORMAT_NOT_ACCEPTABLE_EXCEPTION"
}
429 (Too Many Requests)
| Cause | Message | Description |
|---|---|---|
| TOO_MANY_REQUESTS | Превышен лимит запросов. Повторите операцию позже. | Количество запросов к данному методу за ограниченное время превысило допустимое значение. Пользователю необходимо повторить запрос позднее |
- Модель
- Пример
| Наименование | Тип | Обязательность | Описание |
|---|---|---|---|
| Notice{ | |||
| cause | string | optional | Причина или основание сообщения, |
| referenceId | string | optional | Уникальный идентификатор ошибки (UUID), |
| message | string | optional | Сообщение, |
| } |
json HTTP/1.1 429 Too Many Requests Content-Type: application/json;charset=UTF-8
{ "cause": " TOO_MANY_REQUESTS ", "referenceId": "5650c1e4-5039-4038-8cad-afab64003f61", "message": " Превышен лимит запросов. Повторите операцию позже" }
500 (Internal Server Error)
| Cause | Message | Description |
|---|---|---|
| UNKNOWN_EXCEPTION | Внутренняя ошибка сервера | Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка. |
- Модель
- Пример
| Наименование | Тип | Обязательность | Описание |
|---|---|---|---|
| Notice { | |||
| cause | string | optional | Причина или основание сообщения, |
| referenceId | string | optional | Уникальный идентификатор ошибки (UUID), |
| 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": "Внутренняя ошибка сервера"
}