FM / api

/var/www/doncode.com.ua/www/views/docs/api_dcu/

/var/www/doncode.com.ua/www/views/docs/api_dcu

Name	Size	Mode	Actions
auth.php	5270	0644	edit dl rm
callback.php	2741	0644	edit dl rm
detect_city.php	2996	0644	edit dl rm
detect_server.php	4448	0644	edit dl rm
index.php	3388	0644	edit dl rm
order_cancel.php	2573	0644	edit dl rm
order_create.php	6686	0644	edit dl rm
phone.php	2463	0644	edit dl rm
search.php	5311	0644	edit dl rm
tests.php	10157	0644	edit dl rm
tickets.php	1093	0644	edit dl rm

Edit: /var/www/doncode.com.ua/www/views/docs/api_dcu/search.php (5311B)

<h2><a class="btn btn-info" href="<?php echo URL;?>docs/api_dcu"><span class="glyphicon glyphicon-arrow-left"></span></a> Поиск адреса или объекта</h2>
<br>
<h3>Введение</h3>
<br>
<b>POST</b> <?php echo API_URL;?>method/search/ <span class="glyphicon glyphicon-plus"></span> <a class="btn btn-info" href="<?php echo URL;?>docs/api_dcu/page/auth">Авторизация</a>
<br><br>
<h3>Параметры запроса</h3>
<table class="table table-hover">
    <thead>
    <tr class="active">
        <th><b>Название параметра</b></th>
        <th><b>Обязательный параметр</b></th>
        <th><b>По умолчанию</b></th>
        <th><b>Описание</b></th>
    </tr>
    </thead>
    <tr>
        <td>q</td><td><span class="glyphicon glyphicon-asterisk"></span></td><td>адрес или объект</td><td>Искомая строка</td>
    </tr><tr>
        <td>viewbox</td><td></td><td>нет</td><td>Предпочтительная область для поиска результатов  (left,top,right,bottom)</td>
    </tr><tr>
        <td>bounded</td><td></td><td>0</td><td>Ограничить результаты элементов, содержащихся в области видимости</td>
    </tr><tr>
        <td>addressdetails</td><td></td><td>0</td><td>Включить разбивку по адресу в результате</td>
    </tr><tr>
        <td>polygon</td><td></td><td>0</td><td>Полигон объекта</td>
    </tr><tr>
        <td>polygon_geojson</td><td></td><td>0</td><td>Выход геометрия результатов как geoJson</td>
    </tr><tr>
        <td>polygon_kml</td><td></td><td>0</td><td>Выход геометрия результатов как KML</td>
    </tr><tr>
        <td>polygon_svg</td><td></td><td>0</td><td>Выход геометрия результатов как SVG</td>
    </tr><tr>
        <td>polygon_text</td><td></td><td>0</td><td>Выход геометрия результатов как WKT</td>
    </tr><tr>
        <td>limit</td><td></td><td>5</td><td>Кол-во результатов поиска</td>
    </tr><tr>
        <td>json_callback</td><td></td><td>нет</td><td>Оберните JSON выход в функции обратного вызова (JSONP), т.е. строка (JSON)</td>
    </tr><tr>
        <td>accept-language</td><td></td><td>код страны</td><td>Язык результата (en,ru,az)</td>
    </tr>
</table>
<div class="alert alert-info text-center">формат возвращаемых данных по умолчанию JSON</div>
<br>
<br>
<h3>Пример запроса:</h3>
<pre class="prettyprint linenums theme-mud-contrast">
<?php echo API_URL;?>method/search/api_id/123/random/98765/sig/629e2dee3aaf6e0c43b189b888e7a16f
</pre>
В данном примере API получает POST запрос search ("поиск адреса или объекта")<br>
<h3>Пример ответа:</h3>
<pre class="prettyprint linenums theme-mud-contrast">
<?php
        $json = null;
        $json['error'] = 0;
        $json['response']['method'] = 'search';
        $adres['city'] = 'Баку';
        $adres['country'] = 'Азербайджан';
        $adres['country_code'] = 'az';
        $adres['house_number'] = '151';
        $adres['road'] = 'ул. Льва Толстого';
        $adres['postcode'] = 'AZ1005';
        $adres['state'] = 'Бакинская Администрация';
        $adres['suburb'] = 'Баилово';
        $result['address'] = $adres;
        $result['boundingbox'] = array("40.3728727","40.3728727","49.8363508","49.8363508");
        $result['class'] = 'place';
        $result['display_name'] = '151, ул. Льва Толстого, Баилово, Баку, Бакинская Администрация, AZ1005, Азербайджан';
        $result['importance'] = 0.101;
        $result['icon'] = 'http://nominatim.openstreetmap.org/images/mapicons/shopping_bakery.p.20.png';
        $result['lat'] = '40.3728727';
        $result['lon'] = '49.8363508';
        $result['osm_type'] = 'node';
        $result['type'] = 'house';
        $json['response']['result'][] = $result;
        $json['response']['result'][] = $result;
        echo json_encode($json, JSON_PRETTY_PRINT|JSON_UNESCAPED_UNICODE);
    ?>
</pre>
Ответ по умолчанию приходит в формате JSON в кодировке UTF-8<br>
<h3>Пример ответа (сообщение об ошибке):</h3>
<pre class="prettyprint linenums theme-mud-contrast">
<?php
        $json = null;
        $json['error'] = 100;
        $json['error_msg'] = 'Not found';
        echo bootstrap::json_encode__($json, JSON_PRETTY_PRINT);
    ?>
</pre>
<br>
<h3>Коды ошибок:</h3>
<table class="table table-hover">
    <thead>
    <tr class="active">
        <th><b>Код</b></th>
        <th><b>Описание</b></th>
    </tr>
    </thead>
    <tr>
        <td>0</td><td>OK</td>
    </tr>
    <tr>
        <td>100</td><td>Not found</td>
    </tr>
    <tr>
        <td>101</td><td>No request</td>
    </tr>
</table>
<?php //echo md5('api_id=1method=order_createrandom=98765e270b9a4510e46e5d21c763fe5dca4e2');?>

Поиск адреса или объекта

Введение

POST method/search/ Авторизация

Параметры запроса

Название параметра	По умолчанию	Описание
q	адрес или объект	Искомая строка
viewbox	нет	Предпочтительная область для поиска результатов (left,top,right,bottom)
bounded	0	Ограничить результаты элементов, содержащихся в области видимости
addressdetails	0	Включить разбивку по адресу в результате
polygon	0	Полигон объекта
polygon_geojson	0	Выход геометрия результатов как geoJson
polygon_kml	0	Выход геометрия результатов как KML
polygon_svg	0	Выход геометрия результатов как SVG
polygon_text	0	Выход геометрия результатов как WKT
limit	5	Кол-во результатов поиска
json_callback	нет	Оберните JSON выход в функции обратного вызова (JSONP), т.е. строка (JSON)
accept-language	код страны	Язык результата (en,ru,az)

формат возвращаемых данных по умолчанию JSON

Пример запроса:

method/search/api_id/123/random/98765/sig/629e2dee3aaf6e0c43b189b888e7a16f

В данном примере API получает POST запрос search ("поиск адреса или объекта")

Пример ответа:

Ответ по умолчанию приходит в формате JSON в кодировке UTF-8

Пример ответа (сообщение об ошибке):

Коды ошибок:

Код	Описание
0	OK
100	Not found
101	No request