Документация не поддерживается (фактически метод умеет чуть больше, чем описано). Обратная совместимость в большинстве случаев сохраняется.
Тем не менее, рекомендуем вместо данного метода использовать новый getOrdersWithGoods
Вы можете получить список заказов пользователя сформировав запрос к API сервиса программными методами.
В ответе ваша система получит информацию о заказах.
Запрос передаётся методом POST в формате URLencode на адрес: https://username.justclick.ru/api/GetOrders
где username — это логин пользователя в системе, а так же его домен 3-его уровня в сервисе JustClick.
Параметры передаваемые в запросе
Вы можете передать следующие фильтры:
1 2 3 4 |
date_s - Дата от, в unixtime date_e - Дата до, в unixtime paid - (bool) только оплаченные заказы goods - (string or array) ID продуктов |
Как работает
Вы вызываете функцию API GetOrders.
В ответ ваша система получит результат выполнения функции и массив информации о заказе в переменной result. Массив информации будет выглядеть следующим образом:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
Array( [0] => stdClass Object( [id] => идентификатор ID (номер) заказа, [first_name] => Имя, [last_name] => Фамилия, [middle_name] => Отчество, [email] => email-адрес, [phone] => телефонный номер, [city] => город, [country] => страна, [address] => адрес, [region] => регион, [postalcode] => почтовый индекс, [created] => дата создания заказа, [pay_status] => статус оплаты, [paid] => статус заказа, [type] => тип заказа, [payway] => способ оплаты, [comment] => комментарий к заказу, [domain] => домен заказа, [link] => ссылка на страницу оплаты заказа, [utm] => stdClass Object ( [medium] => утм-параметр канал (если существует) [source] => утм-параметр источник (если существует) [campaign] => утм-параметр кампания (если существует) [content] => утм-параметр объявление (если существует) [term] => утм-параметр ключ (если существует) ) [price] => стоимость продукта ) ) |
Ответ кодирован в формате JSON. Подробнее смотрите «Ответы API сервиса».
Пример на PHP получениия списка заказов
В примере получаем информацию по заказу номер 102937.
Функция GetHash — формирует подпись к передаваемым данным.
Функция CheckHash — проверяет подпись к ответу сервиса.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 |
// Логин в системе Джастклик $user_rs['user_id'] = 'username'; // Ключ для формирования подписи. См. раздел API (ссылка в правом нижнем углу в личном кабинете) $user_rs['user_rps_key'] = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'; // Формируем массив данных для передачи в API $send_data = array( 'date_s' => strtotime('...'), //например, strtotime('01.01.2018') 'date_e' => strtotime('...'), //например, strtotime('01.03.2018') 'paid' => true, //or false 'goods' => array(1, 2, 3) ); // Формируем подпись к передаваемым данным $send_data['hash'] = GetHash($send_data, $user_rs); // Вызываем функцию получения информации о заказе и декодируем полученные данные $resp = json_decode(Send('https://username.justclick.ru/api/GetOrders', $send_data)); // проверяем ответ сервиса if(!CheckHash($resp, $user_rs)){ echo "Ошибка! Подпись к ответу не верна!"; print_r($resp); exit; } if($resp->error_code == 0){ echo "Информация о заказе:"; print_r($resp->result); } else echo "Ошибка код:{$resp->error_code} - описание: {$resp->error_text}"; // =========== Функции отправки, получения и обработки ответа ============ // Отправляем запрос в API сервиса function Send($url, $data) { $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, $url); curl_setopt($ch, CURLOPT_POST, true); curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data)); curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE); curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // выводим ответ в переменную $res = curl_exec($ch); curl_close($ch); return $res; } // Формируем подпись к передаваемым в API данным function GetHash($params, $user_rs) { $params = http_build_query($params); $user_id = $user_rs['user_id']; $secret = $user_rs['user_rps_key']; $params = "$params::$user_id::$secret"; return md5($params); } // Проверяем полученную подпись к ответу function CheckHash($resp, $user_rs) { $secret = $user_rs['user_rps_key']; $code = $resp->error_code; $text = $resp->error_text; $hash = md5("$code::$text::$secret"); if($hash == $resp->hash) return true; // подпись верна else return false; // подпись не верна } |