ym88659208ym87991671
Подключение пакета услуг РКО+ | Документация SmartMarket
Skip to main content

Подключение пакета услуг РКО+

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

  • Тестовый контур https://edupirfintech.sberbank.ru:9443

  • Промышленный контур https://fintech.sberbank.ru:9443

Получение списка клиентов

Ресурс /v1/clients-added позволяет Партнеру получить список клиентов, которые были подключены и переподключены к сервисам Партнера в ВСП за запрашиваемый период (в пределах одного дня).

Шаги

1. Получить AccessToken.

2. Отправить запрос.

Для получения списка необходимо отправить GET-запрос (/v1/clients-added), в котором передать авторизационный токен к данным собственной организации (Access Token) и период за который запрашивается информация. Авторизационный токен передается в параметре Authorization заголовка запроса.

Чтобы получить доступ к ресурсу, необходимо передать в scope сервис GET_CLIENTS_ADDED_VSP.

Модель запроса

НаименованиеОписание
Параметры заголовка
Authorization (String)Access token собственной организации, полученный через SSO
Пример: Bearer c76fb018-27c9-43f7-a751-62646eda7e1a-1
Параметры запроса
datetimeSince (String)Дата и время начала периода (yyyy-MM-dd'T'HH:mm:ss)
datetimeUntil (String)Дата и время окончания периода (yyyy-MM-dd'T'HH:mm:ss)

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

curl -X GET --header 'Accept: application/json' --header
'Authorization: Bearer c76fb018-27c9-43f7-a751-62646eda7e1a-1'
'http://edupirfintech.sberbank.ru:9443/fintech/api/v1/clients-added?datetimeSince=2020-01
20%2010%3A20%3A00&datetimeUntil=2020-01-21%2010%3A20%3A00

Модель ответа

НаименованиеОписание
ClientsAdded {
clientsAdded (Array[ClientAdded], optional)Информация о клиентах
}ClientAdded {
hashOrgId (string, optional)Хэш идентификатора организации,
usersInfo (Array[ClientAddedUserInfo], optional)Информация о пользователях
}ClientAddedUserInfo {
servicesInfo (Array[ClientAddedUserServiceInfo], optional)Подключенные в ВСП платные сервисы,
sub (string, optional)Хэш идентификатора пользователя
}ClientAddedUserServiceInfo {
clientId (integer, optional)Идентификатор сервиса,
refreshToken (string, optional)Токен обновления
}

Пример ответа

{
"clientsAdded":[
{
"hashOrgId":"b4d46153a51567d83e558b9ef2bed1be99e17b54814fa8729b8d77a6896dd8fa",
"usersInfo":[
{
"servicesInfo":[
{
"clientId":0,
"refreshToken":"string"
}
],
"sub":"string"
}
]
}
]
}

Получение данных о подключенных пакетах

Ресурс /v1/service-packages позволяет получить данные о подключенных пакетах услуг клиента.

Шаги

1. Получить AccessToken.

2. Отправить запрос.

Для получения подключенных пакетов услуг необходимо отправить GET-запрос (/v1/service-packages), в котором передать авторизационный токен к данным организации клиента (Access Token). Авторизационный токен передается в параметре Authorization заголовка запроса.

Модель запроса

НаименованиеОписание
Параметры заголовка
Authorization (String)Access token полученный через SSO
Пример: Bearer f8ad3141-b7e8-4924-92de-3de4fd0a464e-1

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

curl -X GET --header 'Accept: application/json' --header
'Authorization: Bearer f8ad3141-b7e8-4924-92de-3de4fd0a464e-1'
'https://edupirfintech.sberbank.ru:9443/fintech/api/v1/service-package'

Модель ответа

НаименованиеОписание
servicePackages {
mainLocation (number)Местонахождение основного вида деятельности,
pointsNumber (string, optional)Кол-во точек организации,
avgBill (string)Средний чек,
employeesNumber (string)Штат сотрудников организации,
avgSalary (string)Среднемесячная заработная плата,
taxationSystem (string)Система налогообложения,
digitalReporting (string)Электронная сдача отчетности,
onlineStore (string)Наличие интернет-магазина,
packageName (string)Название подключенного пакета услуг,
packageCount (string)Количество подключений,
codeWord (string)Кодовое слово,
productNumber (string)Номер выдаваемой ценности (ICC SIM, карта, полис и т.п.),
receiveType (string)Способ получения,
deliveryLoacation (string)Место получения доставки,
cashRegister (string)Название кассового ПО,
is2FR (boolean)Наличие режима 2-ФР,
pointType (string)Формат заведения,
additionalComments (string)Дополнительные комментарии,
isFree (boolean)Признак того, что тариф выдан бесплатно
}

Пример ответа

{
mainLocation (number): "Казань",
pointsNumber (string, optional): "3",
avgBill (string): "35000",
employeesNumber (string): "25",
avgSalary (string): "45000",
taxationSystem (string): "УСН",
digitalReporting (string): "Да",
onlineStore (string): "Нет",
packageName (string): "PRO +",
packageCount (string): "12",
codeWord (string): "Слово",
productNumber (string): "123а34",
receiveType (string): "Курьер",
deliveryLoacation (string): "Москва, ул. Ленина дом 16",
cashRegister (string): "ПАВ465",
is2FR (boolean): true,
pointType (string): "Самообслуживание",
additionalComments (string): "Пакет услуг был предоставлен",
isFree (boolean): false
}

Коды возврата

Код возвратаОписание кода возвратаПричина возникновения
200OKИнформация добавлена/изменена
Информация предоставлена
Запись удалена
400DESERIALIZATION_FAULT
Неверный формат запросаНеверный формат запроса
401UNAUTHORIZED
accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-хУказан некорректный или просроченный access_token.
403ACTION_ACCESS_EXCEPTION
Операция не может быть выполнена: доступ к ресурсу запрещенУ пользователя нет прав на использование соответствующего сервиса SberBusinessAPI, доступ к которому не предусмотрен настройками scope; У пользователя отсутствует оферта с внешним сервисом.
500UNKNOWN_EXCEPTION
Внутренняя ошибка сервера
503UNAVAILABLE_RESOURCE_EXCEPTION
Сервис временно недоступенПроводятся технические работы
Обновлено 20 апреля 2022

Заметили ошибку?

Выделите текст и нажмите Ctrl + Enter, чтобы сообщить нам о ней