Набор сервисов для получения информации об устройствах (АТМ, и тд) Банка.
В зависимости от передаваемых опциональных параметров, можно получить информацию:
- обо всех устройствах Банка
- об устройствах в определенном регионе
- о ближайших устройствах по данным местоположения
- о ближайших устройствах по данным местоположения в определенном регионе
Альтернативная точка подключения для вызова сервиса в продуктивной среде. Зарегистрированное на портале developer.bcc.kz приложение должно быть в режиме "PRODUCTION"
Точка подключения для вызова сервисов в тестовой среде. Зарегистрированное на портале developer.bcc.kz приложение должно быть в режиме "DEVELOPMENT"
Точка подключения для вызова сервиса в продуктивной среде. Зарегистрированное на портале developer.bcc.kz приложение должно быть в режиме "PRODUCTION"
Точка подключения для вызова сервисов в песочнице. Зарегистрированное на портале developer.bcc.kz приложение должно быть в режиме "DEVELOPMENT"
Пути
/atms
Получение информации об устройствах Банка
Токен аутентификации полученный при вызове сервиса авторизации
Режим поиска. Нужно задать по каким параметрам будет идти поиск. Выбирается один из вариантов.
- full - Поиск информации обо всех устройствах Банка.
- geo - Поиск информации о ближайших устройствах Банка в отрезке переданных параметров геолокации.
- reg - Поиск информации об устройствах Банка в определенном регионе (указать код или координаты региона).
{
"enum": [
"full",
"geo",
"reg"
]
}
Если вы выбрали mode = reg, нужно обязательно указать код нужного вам региона. Коды регионов:
- ALM – АЛМАТЫ
- TRZ - ТАРАЗ
- TLD - ТАЛДЫКОРГАН
- ATR - АТЫРАУ
- AKT - АКТАУ
- UST – УСТЬ-КАМЕНОГОРСК
- ATB - АКТОБЕ
- URL – УРАЛЬСК
- SMP - СЕМЕЙ
- GZK - ЖЕЗКАЗГАН
- PVL - ПАВЛОДАР
- SMK - ШЫМКЕНТ
- PTR - ПЕТРОПАВЛОВСК
- AST - АСТАНА
- KZO - КЫЗЫЛОРДА
- KAR - КАРАГАНДА
- KOS – КОСТАНАЙ
- KOK – КОКШЕТАУ
{
"enum": [
"ALM",
"TRZ",
"TLD",
"ATR",
"AKT",
"UST",
"ATB",
"URL",
"SMP",
"GZK",
"PVL",
"SMK",
"PTR",
"AST",
"KZO",
"KAR",
"KOS",
"KOK"
]
}
Долгота
Широта
Радиус поиска (в метрах)
Успешное получение информации.
Ошибка в запросе.
Ошибка работы сервера.
Определения
Координаты
{
"properties": {
"latitude": {
"type": "string",
"example": "43.226021",
"description": "Широта"
},
"longitude": {
"type": "string",
"description": "Долгота",
"example": "76.941288"
}
},
"additionalProperties": false,
"required": [
"latitude",
"longitude"
]
}
Элементы адреса
{
"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": "Дополнительная информация"
}
},
"additionalProperties": false
}
Описание адреса
{
"properties": {
"fullAddress": {
"type": "string",
"description": "Полный адрес",
"example": "050000, КАЗАХСТАН, АЛМАТЫ г, АЛЬ-ФАРАБИ пр-кт, дом 38 корп C, РКО44"
},
"addressElements": {
"$ref": "#\/definitions\/AddressElements"
}
},
"additionalProperties": false,
"required": [
"fullAddress",
"addressElements"
]
}
{
"properties": {
"day": {
"type": "integer",
"format": "int32",
"example": "2",
"description": "День недели"
},
"begin": {
"type": "string",
"example": "00:00",
"description": "Начало"
},
"end": {
"type": "string",
"example": "23:59",
"description": "Конец"
}
},
"additionalProperties": false,
"required": [
"day",
"begin",
"end"
]
}
Время работы
{
"type": "array",
"items": {
"$ref": "#\/definitions\/WorkTimeItems"
}
}
Описание устройства
{
"type": "object",
"properties": {
"deviceId": {
"type": "string",
"example": "ATM00001",
"description": "Уникальный идентификатор устройства"
},
"devicetype": {
"type": "string",
"example": "ATM",
"description": "Тип устройства"
},
"supportDivision": {
"type": "string",
"example": "KAR",
"description": "Код региона"
},
"available": {
"type": "boolean",
"example": true,
"description": "Признак доступности"
},
"address": {
"$ref": "#\/definitions\/Address"
},
"coordinates": {
"$ref": "#\/definitions\/Coordinates"
},
"workTime": {
"$ref": "#\/definitions\/WorkTime"
}
}
}
Список устройств
{
"properties": {
"devices": {
"type": "array",
"description": "Список устройств",
"items": {
"$ref": "#\/definitions\/ATM"
}
}
},
"additionalProperties": false
}
Ошибка
{
"properties": {
"status": {
"type": "string",
"example": 1002,
"description": "Статус ошибки"
},
"description": {
"type": "string",
"example": "Отсутствует или неверное значение для параметра mode",
"description": "Сообщение ошибки"
}
},
"additionalProperties": false,
"required": [
"description"
]
}