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/auth.php (5270B)

<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>
<p>Для защиты информации в системе необходимо авторизовать каждый запрос. Делается это при помощи специальной подписи и ключа API.</p>
<br>
Взаимодействие Вашего приложения или сайта с API производится путем создания HTTP-запроса (POST или GET)<br>
Если запрос без параметров, например method/ping, то это может быть как GET так и POST, с параметрами только POST запрос<br><br>
<b>URL: <?php echo API_URL;?></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>api_id</td><td><span class="glyphicon glyphicon-asterisk"></span></td><td>идентификатор приложения, присваивается при создании ключа.</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>Вашего ключа приложения api_key. <a class="btn btn-info" href="<?php echo URL;?>user/settings#exchange_api">Список API ключей</a></li>
</ul>
<div class="alert alert-info text-center">sig = md5(name1=value1name2=value2api_key)</div>
<br>
В данном случае sig равен md5("api_id=123method=pingrandom=98765api_key"),<br>
то есть <b><?php echo md5('api_id=123method=pingrandom=98765api_key');?></b>
<br>
<br>
<h3>Пример запроса:</h3>
<pre class="prettyprint linenums theme-mud-contrast">
    <?php echo API_URL;?>method/ping/api_id/123/random/98765/sig/e2dfb87b8031cfafb0d16d39ba650287
</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']['api_id'] = '123';
        $json['request']['random'] = '98765';
        $json['request']['sig'] = 'e2dfb87b8031cfafb0d16d39ba650287';
        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>
</table>
<div class="alert alert-info text-center">
    Здесь приведен список базовых ошибок (от 1 до 99).<br>
    Ошибка 0 указывает на успешность обработки запроса.<br>
    Также существуют ошибки самих методов от 100 до 199. Например, запрос составлен правильно, но заказ не найден...<br>
</div>

Авторизация

Введение

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

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

URL:

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

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

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

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

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

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

sig = md5(name1=value1name2=value2api_key)

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

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

    method/ping/api_id/123/random/98765/sig/e2dfb87b8031cfafb0d16d39ba650287

В данном примере 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.

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