API: Баланс лицевого счета

к списку API

Пользователям нашего сервиса во время работы с системой в т.ч. и с API полезно будет иногда проверять о состоянии баланса лицевого счета, чтобы не столкнуться с проблемой остановки работы в связи с недостаточным балансом. Это можно сделать очень просто, отправив несложный XML-запрос.

Как сделать запрос на получения баланса лицевого счета?

Для того, чтобы получить данные, Вам необходимо обратиться к скрипту по адресу https://www.b2seo.net/api/accaunt-balance/api.php (шифрованное соединение) с POST-запросом и отправить в нем с помощью XML такие значения:

  • Элемент KEY - со значением ключа, полученного предварительно Вами
  • Элемент ReturnFormat - со значением формата возвращаемого запроса (XML или JSON)

Пример запроса

Запрос на получение информации о истории индекса в Яндексе и Google для домена domain.ru

<AccauntBalanceQuery>
<Key>b21a4067e204dad697123cafbba5d3ec</Key>
<ReturnFormat>xml</ReturnFormat>
</AccauntBalanceQuery>

Примеры кода на PHP

Для того, чтобы отправить POST-запрос с помощью PHP можно использовать библиотеку curl.

<?
//адрес для отправки запроса
$url = "https://www.b2seo.net/api/indexed-pages/api.php";

//сам зпрос. Вместо b21a4067e204dad697123cafbba5d3ec подставьте свой собственный ключ
$data = "<AccauntBalanceQuery>
<Key>b21a4067e204dad697123cafbba5d3ec</Key>
<ReturnFormat>xml</ReturnFormat>
</AccauntBalanceQuery>";

//инициализируем curl
$ch = curl_init($url);
//вернуть данные
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
//использовать POST-метод
curl_setopt($ch, CURLOPT_POST, true);
//пропустить проверку сертификата
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
//отправить данные из переменной $data
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
//выполнить
$return = curl_exec($ch);
?>

Теперь осталось разобрать полученные данные.

Формат возвращаемых данных

Данные возвращаются в формате XML или JSON. Если Вы используете PHP для обработки данных существует стандартная функция json_decode, которая вернет Вам удобный для работы объект или ассоциативный массив. Однако, по порядку.

Для начала необходимо проверить данные из элемента "Status". Если значение элемента не равняется 1, значит произошла ошибка. Кода ошибок:

  • 0 - нет доступа. Это означает, что API-ключ указан неверно, или IP хоста, с которого пришел запрос, не соответствует установелнным Вами ограничениям.
  • 2 - не указан один из параметров/неверный формат запроса

Так выглядит ответ в формате XML:
<BalanceAnswer>
<Status>1</Status>
<Balance>12.568</Balance>
<Bonus>3.000</Bonus>
</BalanceAnswer>

Так выглядит ответ в формате JSON:
{
"Status": "1",
"balance":"12.568",
"bonus":"3.000"
}
где элементы "balance" - баланс лицевого счета, "bonus" - количество бонусов (нельзя использовать при работе с API сервиса), "Status" - код ответа.

Если у Вас возникают вопросы, обращайтесь в поддержку: iCQ: 474-500,

 
 

Приветствуем, Гость. Войдите или зарегистрируйтесь.

Домены

Аналитика

Контент для сайтов

Аналитика