PHP API

Контроллер доступа к сервису — Kladr\Api

Функции:

QueryToJson(Query $query) - выполняет запрос к сервису, возвращая данные в виде объекта Json
QueryToArray(Query $query) - выполняет запрос к сервису, возвращая данные в виде ассоциативного массива
QueryToObjects(Query $query) - выполняет запрос к сервису, возвращая данные в виде массива объектов

Свойства:

Error - текст последней, возникшей при обращении к сервису, ошибки

Объект запроса — Kladr\Query

Свойства:

ParentType - тип родительского объекта для ограничения области поиска (регион, район, город)
ParentId - идентификатор родительского объекта для ограничения области поиска
ContentType - тип искомого объекта (регион, район, город)
ContentName - название искомого объекта
WithParent - получить объекты вместе с родителями (если true у объекта заполняется свойство Parent)
Limit - ограничение количества возвращаемых объектов

Объект базы — Kladr\Object

Свойства:

Id - идентификатор объекта
Name - название объекта
Zip - почтовый индекс объекта
Type - подпись объекта полностью (область, район)
TypeShort - подпись объекта коротко (обл, р-н)
Parents - массив родительских объектов (заполняется если в запросе был установлен флаг WithParent)

Перечисление типов объектов, используемых в запросах к сервису — Kladr\ObjectType

Константы:

Region - регион
District - район
City - населённый пункт
Street - улица
Building - строение

Примеры

Получение списка всех населённый пунктов, название которых начинается на "Арх"

// Инициализация api, в качестве параметров указываем токен и ключ для доступа к сервису
$api = new Kladr\Api('51dfe5d42fb2b43e3300006e', '86a2c2a06f1b2451a87d05512cc2c3edfdf41969');

// Формирование запроса
$query = new Kladr\Query();
$query->ContentName = 'Арх';
$query->ContentType = Kladr\ObjectType::City;
$query->WithParent = true;
$query->Limit = 2;

// Получение данных в виде ассоциативного массива
$arResult = $api->QueryToArray($query);