Содержание
Вы можете получить список всех групп контактов из вашего аккаунта, сформировав запрос к API сервиса программными методами.
В ответе ваша система получит массив, в котором для каждой группы будут пререданы ID группы и её название. Авто-группы не будут включены в этот список.
Запрос передаётся методом POST в формате URLencode на адрес: https://username.expertam.ru/api/GetAllGroups
где username — это логин пользователя в системе, а так же его домен 3-его уровня в сервисе Expertam.
Параметры передаваемые в запросе
Для этой функции нет параметров. Вам достаточно просто вызвать её. Единственным передаваемым параметром, как и для всех других запросов, будет подпись к запросу.
Как работает
Вы вызываете функцию API GetAllGroups.
В ответ ваша система получит результат выполнения функции и массив с группами подписки в переменной result. Массив групп будет выглядеть следующим образом:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
$resp->result = Array ( [0] => array ( [rass_id] => системный ID группы [rass_name] => API ID группы 1 [rass_title] => Название группы 1 ) [1] => array ( [rass_id] => системный ID группы 2 [rass_name] => API ID группы 2 [rass_title] => Название группы 2 ) [2] => array ( [rass_id] => системный ID группы 3 [rass_name] => API ID группы 3 [rass_title] => Название группы 3 ) ) |
Ответ кодирован в формате JSON. Подробнее смотрите «Ответы API сервиса».
Пример на PHP получениия списка всех групп из аккаунта
Функция 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 |
// Логин в системе Expertam $user_rs['user_id'] = 'username'; // Ключ для формирования подписи. См. раздел API (ссылка в правом нижнем углу в личном кабинете) $user_rs['user_rps_key'] = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'; // Формируем подпись к передаваемым данным $send_data['hash'] = GetHash(null, $user_rs); // Вызываем функцию получение списка групп по мейлу клиента и декодируем полученные данные $resp = json_decode(Send('https://username.expertam.ru/api/GetAllGroups', $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; // подпись не верна } |
Загрузка...