API сайта notacash.com предоставляет доступ к базе данных банкоматов в виде REST-протокола. В первой версии все данные отправляются в формате JSON. В будущем планируется поддержка XML.

В следующей версии будет доступен расширенный API для зарегистрированных пользователей. Появится ряд дополнительных возможностей, таких как:

• сохранение настроек поиска (фильтры) - пользователь получит возможность сохранять такие параметры поиска, как: выбор категории (банк, сеть банкоматов), радиус поиск и др.;
• добавление новых объектов на карту- например, возможность добавления нового банкомата.

Категории

В данный момент поиск разделен на три категоии:

• банкоматы;
• сеть банкоматов;
• сеть терминалов самообслуживания.

Просмотр списка всех категорий

URL: https://notacash.com/api/category

В результате будет получен массив JSON-объектов следующего формата:

                        {
                            id: 0, // Идентификатор категории
                            name: "Банкоматы" // Имя категории
                        }
                    

Просмотр информации о категории

URL: https://notacash.com/api/category/{category_id}
Параметры:

• category_id - идентификатор категории.

В результате будет получен JSON-объект с такими полями:

                        {
                            id: 0, // Идентификатор категории
                            name: "Банкоматы" // Имя категории
                            defaultImage: "https://notacash.com/staic/images/atm/default.png" // Картинка по умолчанию
                            onlineImage: "https://notacash.com/static/images/atm/offline.png" // Картинка объекта, который доступен в данный момент
                            offlineImage: "https://notacash.com/static/images/atm/online.png" // Картинка объекта, который не доступен в данный момент
                            subcategories:                 // Список подкатегорий
                                [ {  id: 0,                // Идентификатор
                                     name: 'Все банки'} ]  // Имя
                        }
                    

В случае, если категория не найдена будет возвращена строка null с кодом 404.

Подкатегории

Подкатегории введены для более удобного и точного поиска. В случае с поиском банкоматов по банку, в списке подкатегорий будут все банки, при поиске по сетям банкоматов - список сетей.

Более подробно о картинках на примере картинок для банкоматов:

• defaultImage - стандартная иконка для банкоматов;
• onlineImage - иконка отображается в случае, если банкомат работает в момент поиска;
• offlineImage - иконка отображется в случае, если банкомат не работает в момент поиска (например: график работы с 9:00 до 20:00, а посик просиходит в 21:00)

Поиск

URL: https://notacash.com/api/search/{category_id}/{subcategory_id}/{latitude}/{longitude}/{radius}
Параметры:

• category_id - категория;
• subcategory_id - подкатегория;
• latitude - широта;
• longitude - долгота;
• radius - радиус поиска (в метрах) в диапазоне от 0 до 1000.

При поиске банкоматов будет получен массив JSON-объектов следующего формата:

                        {
                            lat: 0                  // Широта
                            lng: 0,                 // Долгота
                            address: '',            // Адресс
                            city: ''                // Город
                            bank: '',               // Название банка
                            workTime: '9:00-20:00', // Время работы
                            locationType: ''        // Местоположения банкомата
                        }