меню
Generic selectors
Exact matches only
Search in title
Search in content
Search in posts
Search in pages

Метод getFields

Метод для получения перечня пользовательских полей.

Принцип использования

Синтаксис и URL для вызова метода
getFields ()
https://api.unisender.com/ru/api/getFields?format=json&api_key=KEY
Аргументы
api_key * Ключ доступа к API
Возвращаемое значение
JSON-массив, каждый элемент массива – объект с полями id, name, type, is_visible и view_pos. Описания этих полей смотрите в описании аргументов метода createField.

Пример возвращаемого значения:

{
  "result":[
    {"id":21575,"name":"Name","type":"string","is_visible":1,"view_pos":1},
    {"id":1255,"name":"Lastname","type":"string", is_visible":1,"view_pos":1} 
  ] 
}

Примеры на PHP

Мы настоятельно рекомендуем использовать POST-запросы, так как это более безопасный метод передачи данных, нежели GET. Используйте SSL-соединение с UniSender. Подробнее о методах соединения здесь.

Пример с использованием POST-запроса

// Ваш ключ доступа к API (из Личного Кабинета)
$api_key = "xxxxxxxxxxxxxxxxxxxxxxxxx";

// Создаём 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, 
            'https://api.unisender.com/ru/api/getFields?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 fields:
";
    foreach ($jsonObj->result as $one) {
      echo "Field #" . $one->id . " (" . $one->name . ")". "
";
    }

  }
} else {
  // Ошибка соединения с API-сервером
  echo "API access error";
}

Пример с использованием GET-запроса

// Ваш ключ доступа к API (из Личного Кабинета)
$api_key = "xxxxxxxxxxxxxxxx";

// Создаём GET-запрос
$api_url = "https://api.unisender.com/ru/api/getFields?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 fields:
";
    foreach ($jsonObj->result as $one) {
      echo "Field #" . $one->id . " (" . $one->name . ")". "
";
    }
  }

} else {
  // Ошибка соединения с API-сервером
  echo "API access error";
}