API представляет сервис для получения регистрационной информации и изменения статуса регистрации для WhiteLabel Мое Дело.
Условия использования API:
- Партнером получен приватный сертификат
- Реализован переход (редирект) из системы Банка на Whitelabel Партнера в рамках интеграционного решения.
- Системой Партнера получен access_token клиента
Бизнес-описание процесса, логику которого реализует API:
1) Пользователь Банка осуществляет переход из системы Банка в систему Партнера (WhiteLabel)
2) Система Партнера проходит аутентификацию от имени пользователя Банка и получает код аутентификации (code) от Банка
3) Система Партнера запрашивает токен доступа (access_token) с использованием полученного ранее code.
4) Система Партнера получает данные для регистрации организации. Метод /client/info
5) Система Партнера сообщает статус регистрации организации в WhiteLabel. Метод /client/status
Для работы с API сервис предоставляет следующие методы:
- GET /client/info - получение информации для регистрации организации в WhiteLabel Партнера (Мое Дело).
- POST /client/status - обновление статуса регистрации организации в WhiteLabel Партнера (Мое Дело).
Порядок вызова методов:
1) Получение информации для регистрации организации.
Для получения информации по организации вызвать метод GET /client/info. На вход передается токен доступа (access_token), полученный на третьем шаге, CorrelationId = (указывается уникальный идентификатор операции). В случае успешной обработки запроса API отдает информацию по организации в json.
2) Обновление статуса регистрации организации.
Для обновления статуса регистрации вызвать метод POST /client/status. На вход передается токен доступа (access_token), полученный на третьем шаге, и значение статуса регистрации организации на WhiteLabel Партнера (Мое Дело).В случае успешной обработки запроса API возвращает 200 OK.
Возможные коды ошибок:
| Code | Описание |
|---|---|
| 400 Bad request | Некорректный запрос |
| 401 Unauthorized | Ошибка авторизации, некорректный X-IBM-Client-Id, X-IBM-Client-Secret |
| 500 Internal Error | Ошибка обработки данных. org.apache.thrift.TException: Access denied. Организация не находится в статусе "requested" |
Статусы регистрации организации:
- AVAILABLE - организация доступна для регистрации в WL Партнера.
- REQUESTED - был выполнен запрос регистрации в WL Партнера.
- DENIED - регистрация организации WL Партнера невозможна.
- ENABLED - была выполнена регистрация WL Партнера.
- DISABLED - регистрация организации WL Партнера отменена.
TLS RSA
TLS ГОСТ Режим разработки
TLS ГОСТ Промышленный режим
Paths
/client/status
Уведомление о статусе регистрации клиента в WL-бухгалтерии
Client ID Приложения (Приложение должно быть подписано на сервис)
Client Secret Приложения (Приложение должно быть подписано на сервис)
Указать: Bearer
Любой уникальный id
Статус регистрации
OK
error
/client/info
Запрос реквизитов клиента для быстрой регистрации в WL-Бухгалтерии
Client ID Приложения (Приложение должно быть подписано на сервис)
Client Secret Приложения (Приложение должно быть подписано на сервис)
Указать: Bearer
Любой уникальный id
OK
error
Definitions
Статус регистрации клиента в WL-бухгалтерии
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "статус подключения услуги WL-бухгалтерия для Клиента",
"enum": [
"REQUESTED",
"DENIED",
"ENABLED",
"DISABLED"
],
"example": "ENABLED"
},
"data": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"example": "{ \"id\": 412838428409856 }"
}
},
"required": [
"status"
]
}
Регистрационная информация Клиента
{
"type": "object",
"properties": {
"inn": {
"type": "string",
"description": "ИНН Клиента"
},
"phone": {
"type": "string",
"description": "Телефон. Используется для реквизитов и документов, а также в электронной отчетности."
},
"email": {
"type": "string",
"description": "E-mail. Уведомления, логин при авторизации"
},
"sno": {
"type": "string",
"description": "Система налогообложения Клиента УСН / УСН + ЕНВД / ЕНВД / ОСНО и т.д.",
"enum": [
"USN_6",
"USN_16",
"ENVD",
"OSNO",
"ESHN",
"PSN",
"MULTI"
]
},
"nameForDocuments": {
"type": "string",
"description": "Наименование для документов"
},
"okpo": {
"type": "string",
"description": "ОКПО"
},
"accounts": {
"type": "array",
"description": "счета клиента",
"items": {
"type": "string"
}
},
"roleInOrganization": {
"type": "string",
"description": "роль в организации",
"enum": [
"MANAGER",
"ACCOUNTANT"
]
}
}
}
error
{
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "error code"
},
"message": {
"type": "string",
"description": "error description"
}
},
"required": [
"error"
]
}