Метод getUserInfo
Метод для получения информации о пользователе и состоянии его счёта. Можно получить информацию о себе или о прикреплённых к партнёру пользователях.
Данный метод работает только для аккаунтов, имеющих статус реселлера.
Принцип использования
| Синтаксис и URL для вызова метода |
|---|
| getUserInfo ([string login]) |
| http://api.unisender.com/ru/api/getUserInfo?format=json&api_key=KEY&login=LOGIN |
| Аргументы | |
|---|---|
| api_key * | Ключ доступа к API |
| login | Логин пользователя, информацию по которому хочется получить. Если отсутствует или пустой, то выдаётся информация об обратившемся пользователе. |
| Возвращаемое значение | |
|---|---|
| JSON-объект со следующими полями: | |
| login | Логин пользователя |
| master | Если пользователь является «дополнительным», здесь указан логин основного пользователя, иначе это поле будет пустым. |
| balance | Состояние счёта пользователя в валюте currency. Может быть и отрицательным. |
| currency | Валюта пользователя, в которой указан баланс, одна из: RUB, USD, EUR или UAH. |
| emails_paid | Количество e-mail сообщений по тарифу «Редко», оплаченных пользователем за всё время пользования сервисом. |
| emails_used | Количество e-mail сообщений по тарифу «Редко», отправленных пользователем за всё время пользования сервисом. |
| period_emails_paid | Количество e-mail сообщений, оплаченных пользователем в текущем периоде (месяце) |
| period_emails_used | Количество e-mail сообщений, отправленных пользователем в текущем периоде (месяце) |
| email_period_start | Начало текущего периода в формате «ГГГГ-ММ-ДД чч:мм:сс» в часовом поясе UTC |
| email_period_end | Конец текущего периода в формате «ГГГГ-ММ-ДД чч:мм:сс» в часовом поясе UTC |
Пример возвращемого значения:
{
"result":{
"login":"test_user_login",
"master":"test_main_login",
"balance":18.52,
"currency":"USD",
"emails_paid":0,
"emails_used":40734,
"period_emails_paid":1000,
"period_emails_used":0,
"email_period_start":"2011-01-03 00:46:02",
"email_period_end":"2011-02-03 00:46:02"
}
}
| |
Смотрите также
Примеры на PHP
Мы настоятельно рекомендуем использовать POST-запросы, так как это более безопасный метод передачи данных, нежели GET. Подробнее о методах соединения здесь.
Пример с использованием POST-запроса
// Ваш ключ доступа к API (из Личного Кабинета)
$api_key = "xxxxxxxxxxxxxxxx";
// Логин пользователя, о ком надо узнать иформацию (если пусто - о себе)
$user_name = "";
// Создаём POST-запрос
$POST = array (
'api_key' => $api_key,
'login' => $user_name
);
// Устанавливаем соединение
$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/getUserInfo?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 "User login: " . $jsonObj->result->login . "<br>";
echo "Account owner: " . $jsonObj->result->master . "<br>";
echo "User account balance: " . $jsonObj->result->balance . " " .
$jsonObj->result->currency . "<br>";
}
} else {
// Ошибка соединения с API-сервером
echo "API access error";
}
Пример с использованием GET-запроса
// Ваш ключ доступа к API (из Личного Кабинета)
$api_key = "xxxxxxxxxxxxxx";
// Логин пользователя, о ком надо узнать иформацию (если пусто - о себе)
$user_name = "";
// Создаём GET-запрос
$api_url = "http://api.unisender.com/ru/api/getUserInfo?format=json".
"&api_key=$api_key&login=$user_name";
// Делаем запрос на 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 "User login: " . $jsonObj->result->login . "<br>";
echo "Account owner: " . $jsonObj->result->master . "<br>";
echo "User account balance: " . $jsonObj->result->balance . " " .
$jsonObj->result->currency . "<br>";
}
} else {
// Ошибка соединения с API-сервером
echo "API access error";
}


