Метод getLists
Метод для получения перечня всех имеющихся списков рассылок.
Принцип использования
| Синтаксис и URL для вызова метода |
|---|
| getLists () |
| http://api.unisender.com/ru/api/getLists?format=json&api_key=KEY |
| Аргументы | |
|---|---|
| api_key * | Ключ доступа к API |
| Возвращаемое значение | |
|---|---|
|
JSON-массив, каждый элемент массива – объект с полями id и title. Возможно, в будущем будут добавлены
и другие поля. Пример возвращаемого значения:
{
"result":[
{"id": 55688, "title": "My list number 1"},
{"id": 224589, "title": "Это мой второй список"},
{"id": 210012, "title": "И третий"},
]
}
|
Смотрите также
Примеры на PHP
Мы настоятельно рекомендуем использовать POST-запросы, так как это более безопасный метод передачи данных, нежели GET. Подробнее о методах соединения здесь.
Пример с использованием POST-запроса
// Ваш ключ доступа к API (из Личного Кабинета)
$api_key = "xxxxxxxxxxxxxxxx";
// Создаём POST-запрос
$POST = array (
'api_key' => $api_key,
);
// Устанавливаем соединение
$ch = curl_init();
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $POST);
curl_setopt($ch, CURLOPT_TIMEOUT, 10);
curl_setopt($ch, CURLOPT_URL, 'http://api.unisender.com/ru/api/getLists?format=json');
$result = curl_exec($ch);
if ($result) {
// Раскодируем ответ API-сервера
$jsonObj = json_decode($result);
if(null===$jsonObj) {
// Ошибка в полученном ответе
echo "Invalid JSON";
}
elseif(!empty($jsonObj->error)) {
// Ошибка получения перечня список
echo "An error occured: " . $jsonObj->error . "(code: " . $jsonObj->code . ")";
} else {
// Выводим коды и названия всех имеющихся списков
echo "Here's a list of your mailing lists:<br>";
foreach ($jsonObj->result as $one) {
echo "List #" . $one->id . " (" . $one->title . ")". "<br>";
}
}
} else {
// Ошибка соединения с API-сервером
echo "API access error";
}
Пример с использованием GET-запроса
// Ваш ключ доступа к API (из Личного Кабинета)
$api_key = "xxxxxxxxxxxxxxxxxxxxxx";
// Создаём GET-запрос
$api_url = "http://api.unisender.com/ru/api/getLists?format=json&api_key=$api_key";
// Делаем запрос на API-сервер
$result = file_get_contents($api_url);
if ($result) {
// Раскодируем ответ API-сервера
$jsonObj = json_decode($result);
if(null===$jsonObj) {
// Ошибка в полученном ответе
echo "Invalid JSON";
}
elseif(!empty($jsonObj->error)) {
// Ошибка получения перечня списков
echo "An error occured: " . $jsonObj->error . "(code: " . $jsonObj->code . ")";
} else {
// Выводим коды и названия всех имеющихся списков
echo "Here's a list of your mailing lists:<br>";
foreach ($jsonObj->result as $one) {
echo "List #" . $one->id . " (" . $one->title . ")". "<br>";
}
}
} else {
// Ошибка соединения с API-сервером
echo "API access error";
}
Правила использования | Политика конфиденциальности
| Анти-спам политика
© UniSender 2008-2011