FM / api

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

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

Name	Size	Mode	Actions
adres_list.php	2449	0644	edit dl rm
auth.php	5529	0644	edit dl rm
balance_list.php	2467	0644	edit dl rm
cars_list.php	2921	0644	edit dl rm
delete_card.php	2754	0644	edit dl rm
get_adresses.php	2443	0644	edit dl rm
index.php	11414	0644	edit dl rm
map.php	2425	0644	edit dl rm
option_list.php	2260	0644	edit dl rm
orders_list.php	2629	0644	edit dl rm
order_cancel.php	2981	0644	edit dl rm
order_create.php	5830	0644	edit dl rm
order_status.php	5214	0644	edit dl rm
ping.php	1983	0644	edit dl rm
rate.php	3142	0644	edit dl rm
reverse.php	4010	0644	edit dl rm
route.php	3716	0644	edit dl rm
route_adresses.php	4161	0644	edit dl rm
save_card.php	3356	0644	edit dl rm
search.php	5367	0644	edit dl rm
settings.php	2603	0644	edit dl rm
settings_save.php	2777	0644	edit dl rm
sms_accept.php	3667	0644	edit dl rm
sms_send.php	2615	0644	edit dl rm
status_list.php	3460	0644	edit dl rm
tarifs_list.php	2536	0644	edit dl rm
tests.php	15917	0644	edit dl rm

Edit: /var/www/doncode.com.ua/www/views/docs/api_dcc/auth.php (5529B)

<h2><a class="btn btn-info" href="<?php echo URL;?>docs/api_dcc"><span class="glyphicon glyphicon-arrow-left"></span></a> Авторизация Doncode Call Center</h2>
<br>
<h3>Введение</h3>
<p>Для защиты информации в системе необходимо авторизовать каждый запрос. Делается это при помощи специальной подписи и ключа API.</p>
<br>
Взаимодействие Вашего приложения или сайта с API производится путем создания HTTP-запроса (POST или GET)<br>
Если запрос без параметров, например method/ping, то это может быть как GET так и POST, с параметрами только POST запрос<br><br>
<b>URL: <?php echo 'http://'.session::get('taxi_host').':'.session::get('taxi_port').'/api/';?></b>
<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>
    </tr>
    </thead>
    <tr>
        <td>client_key</td><td></td><td>Ключ клиента (<b>приходит после <a href="<?php echo URL; ?>docs/api_dcc/page/sms_accept">активации по СМС</a></b>)</td>
    </tr>
    <tr>
        <td>method</td><td><span class="glyphicon glyphicon-asterisk"></span></td><td>название метода API из общего списка функций.</td>
    </tr>
    <tr>
        <td>random</td><td><span class="glyphicon glyphicon-asterisk"></span></td><td>любое случайное число для обеспечения уникальности запроса.</td>
    </tr>
    <tr>
        <td>sig</td><td><span class="glyphicon glyphicon-asterisk"></span></td><td>подпись, которая создается в целях безопасности. Порядок создания подписи описан ниже.</td>
    </tr>
</table>
<div class="alert alert-info text-center">формат возвращаемых данных по умолчанию JSON.</div>
<br>
<h3>Подпись запроса</h3>
Параметр <b>sig</b> равен md5 от соединения следующих строк:<br>
<br>
<ul>
    <li>пар "parameter_name=parameter_value", расположенных в порядке возрастания имени параметра.</li>
    <li>Вашего ключа системы <b><?php echo session::get('taxi_key');?></b></li>
</ul>
<div class="alert alert-info text-center">sig = md5(name1=value1name2=value2api_key)</div>
В данном случае sig равен md5("method=pingrandom=98765<?php echo session::get('taxi_key');?>"),<br><br>
<div class="alert alert-danger text-center">Обратите внимание, что api_id здесь не используется!</div>
то есть <b><?php echo md5('api_id=123method=pingrandom=98765'.session::get('taxi_key'));?></b>
<br>
<br>
<h3>Пример запроса:</h3>
<pre class="prettyprint linenums theme-mud-contrast">
    <?php echo API_URL;?>method/ping/random/98765/sig/fac89234d582e609131c056ebf3fd503
</pre>
В данном примере API получает запрос ping ("проверка соединения").<br>
<h3>Пример ответа:</h3>
<pre class="prettyprint linenums theme-mud-contrast">
<?php
        $json = null;
        $json['error'] = 0;
        $json['response']['method'] = 'pong';
        echo json_encode($json, JSON_PRETTY_PRINT);
    ?>
</pre>
Ответ по умолчанию приходит в формате JSON в кодировке UTF-8.<br>
<h3>Пример ответа (сообщение об ошибке):</h3>
<pre class="prettyprint linenums theme-mud-contrast">
<?php
        $json = null;
        $json['error'] = 4;
        $json['error_msg'] = 'Incorrect signature.';
        $json['request']['method'] = 'ping';
        $json['request']['random'] = '98765';
        $json['request']['sig'] = '123fac89234d582e609131c056ebf3fd503';
        echo 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>1</td><td>Unknown error occured</td>
    </tr>
    <tr>
        <td>2</td><td>Application is disabled. Enable your application</td>
    </tr>
    <tr>
        <td>3</td><td>Unknown method passed</td>
    </tr>
    <tr>
        <td>4</td><td>Incorrect signature</td>
    </tr>
    <tr>
        <td>5</td><td>User authorization failed</td>
    </tr>
    <tr>
        <td>6</td><td>Invalid request</td>
    </tr>
    <tr>
        <td>7</td><td>Empty database</td>
    </tr>
    <tr>
        <td>8</td><td>User authorization required</td>
    </tr>
</table>
<div class="alert alert-info text-center">
    Здесь приведен список базовых ошибок (от 1 до 99).<br>
    Ошибка 0 указывает на успешность обработки запроса.<br>
    Также существуют ошибки самих методов от 100 до 199. Например, запрос составлен правильно, но заказ не найден...<br>
</div>

Авторизация Doncode Call Center

Введение

Для защиты информации в системе необходимо авторизовать каждый запрос. Делается это при помощи специальной подписи и ключа API.

Взаимодействие Вашего приложения или сайта с API производится путем создания HTTP-запроса (POST или GET)
Если запрос без параметров, например method/ping, то это может быть как GET так и POST, с параметрами только POST запрос

URL:

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

Название параметра	Обязательный параметр	Описание
client_key		Ключ клиента (приходит после активации по СМС)
method		название метода API из общего списка функций.
random		любое случайное число для обеспечения уникальности запроса.
sig		подпись, которая создается в целях безопасности. Порядок создания подписи описан ниже.

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

Подпись запроса

Параметр sig равен md5 от соединения следующих строк:

пар "parameter_name=parameter_value", расположенных в порядке возрастания имени параметра.
Вашего ключа системы

sig = md5(name1=value1name2=value2api_key)

В данном случае sig равен md5("method=pingrandom=98765"),

Обратите внимание, что api_id здесь не используется!

то есть

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

    method/ping/random/98765/sig/fac89234d582e609131c056ebf3fd503

В данном примере API получает запрос ping ("проверка соединения").

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

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

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

Коды ошибок:

Код	Описание
1	Unknown error occured
2	Application is disabled. Enable your application
3	Unknown method passed
4	Incorrect signature
5	User authorization failed
6	Invalid request
7	Empty database
8	User authorization required

Здесь приведен список базовых ошибок (от 1 до 99).
Ошибка 0 указывает на успешность обработки запроса.
Также существуют ошибки самих методов от 100 до 199. Например, запрос составлен правильно, но заказ не найден...