API сайта notacash.com (beta)

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

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

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

Категории

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

  • банкоматы.
  • сеть банкоматов.

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

URL: http://notacash.com/api/categories

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

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

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

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

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

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

                        {
                            CategoryId: 0, // Идентификатор категории
                            CategoryName: "Банкоматы" // Имя категории
                            DefaultImage: "http://notacash.com/images/atm/default.png" // Картинка по умолчанию
                            OnlineImage: "http://notacash.com/images/atm/offline.png" // Картинка объекта, который доступен в данный момент
                            OfflineImage: "http://notacash.com/images/atm/online.png" // Картинка объекта, который не доступен в данный момент
                            Subcategories:                 // Список подкатегорий
                                [ {  Id: 0,                // Идентификатор
                                     Name: 'Все банки'} ]  // Имя
                        }
                    
В случае, если категория не найдена будет возвращена строка null с кодом 404.

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

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

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

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

Поиск

URL: http://notacash.com/api/search/{categoryId}/{subCategoryId}/{latitude}/{longitude}/{radius}
Параметры:

  • categoryId - категория;
  • subCategoryId - подкатегория;
  • latitude - широта;
  • longitude - долгота;
  • radius - радиус поиска (в метрах).

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

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