Набор сервисов для получения информации о доступных сейфовых ячейках в определенном отделении Банка.
Альтернативная точка подключения для вызова сервиса в продуктивной среде. Зарегистрированное на портале developer.bcc.kz приложение должно быть в режиме "PRODUCTION"
Точка подключения для вызова сервисов в тестовой среде. Зарегистрированное на портале developer.bcc.kz приложение должно быть в режиме "DEVELOPMENT"
Точка подключения для вызова сервиса в продуктивной среде. Зарегистрированное на портале developer.bcc.kz приложение должно быть в режиме "PRODUCTION"
Точка подключения для вызова сервисов в песочнице. Зарегистрированное на портале developer.bcc.kz приложение должно быть в режиме "DEVELOPMENT"
Пути
/safes
Получение списка доступных ячеек
Авторизация посредством вызова запроса с механизмом HTTP Basic аутентификации
Филиал
Типоразмер ячейки
{
"enum": [
"SMALL",
"MEDIUM",
"BIG",
"GRAND"
]
}
Успешное получение информации
Ошибка в запросе
Ошибка сервера
Определения
Элементы адреса
{
"properties": {
"country": {
"type": "string",
"example": "Казахстан",
"description": "Страна"
},
"region": {
"type": "string",
"example": "Атырауская",
"description": "Область"
},
"district": {
"type": "string",
"example": "Жылыойский",
"description": "Район"
},
"city": {
"type": "string",
"example": "Атырау",
"description": "Город"
},
"street": {
"type": "string",
"example": "Аль-Фараби",
"description": "Улица"
},
"microdistrict": {
"type": "string",
"example": "Оркен",
"description": "Микрорайон"
},
"building": {
"type": "string",
"example": "38C",
"description": "Здание"
},
"flat": {
"type": "string",
"example": "кв.1",
"description": "Квартира"
},
"addraddinfo": {
"type": "string",
"example": "ВОЗЛЕ ЖИЛОГО ДОМА №45",
"description": "Дополнительная информация"
}
}
}
Описание адреса
{
"properties": {
"fullAddress": {
"type": "string",
"description": "Полный адрес",
"example": "050000, КАЗАХСТАН, АЛМАТЫ г, АЛЬ-ФАРАБИ пр-кт, дом 38 корп C, РКО44"
},
"addressElements": {
"$ref": "#\/definitions\/AddressElements"
}
},
"required": [
"fullAddress"
]
}
Описание подразделения
{
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "AQ5",
"description": "Код подразделения"
},
"name": {
"type": "string",
"example": "Отделение 1",
"description": "Наименование подразделения"
},
"address": {
"$ref": "#\/definitions\/Address"
},
"safeVaults": {
"properties": {
"subtypes": {
"type": "array",
"description": "Субтипы сейфовых ячеек (с размерами)",
"items": {
"$ref": "#\/definitions\/SafeSubtype"
}
}
}
}
}
}
Описание ответа для сервиса поиска доступных сейфовых ячеек
{
"type": "object",
"properties": {
"branch": {
"type": "string",
"example": "AQ5",
"description": "Филиал"
},
"safeType": {
"type": "string",
"example": "SMALL",
"description": "Типоразмер ячейки"
},
"depts": {
"type": "array",
"description": "Список отделений банка",
"items": {
"$ref": "#\/definitions\/Department"
}
}
}
}
Субтип сейфовых ячеек (с размерами)
{
"type": "object",
"properties": {
"height": {
"type": "integer",
"example": 7,
"description": "Высота"
},
"width": {
"type": "integer",
"example": 26,
"description": "Ширина"
},
"depth": {
"type": "integer",
"example": 39,
"description": "Глубина"
},
"safes": {
"type": "array",
"description": "Список кодов свободных ячеек",
"items": {
"type": "string",
"example": "SMALL_01"
}
}
}
}
Ошибка
{
"properties": {
"status": {
"type": "string",
"example": 1002,
"description": "Статус ошибки"
},
"description": {
"type": "string",
"example": "Код подразделения отсутствует или пуст",
"description": "Сообщение ошибки"
}
},
"additionalProperties": false,
"required": [
"description"
]
}