Документация

Документация по API Capsola для получения баланса

Чтобы получить информацию о балансе с помощью API Capsola,
выполните HTTP GET запрос к адресу https://api.capsola.cloud/balance.

  1. Создайте запрос
    Используйте любой инструмент для создания HTTP запросов. Например, можно воспользоваться Postman или написать код для отправки запроса.
  2. Укажите хост и заголовки
    Убедитесь, что в заголовке запроса указаны следующие значения:
    • Host: api.capsola.cloud
    • Content-Type: application/json
    • X-API-Key: API_KEY
  3. Сформируйте тело запроса
    Тело запроса должно быть пустым, так как для получения баланса не требуется отправка дополнительных данных.
  4. Отправьте запрос
    Отправьте HTTP GET запрос на адрес https://api.capsola.cloud/balance.
  5. Получите ответ
    Результат запроса будет представлен в формате JSON.

Примеры ответа

Успешный ответ:

{
    "status": 1,
    "response": 100
}

В данном примере status равно 1, что указывает на успешное выполнение запроса, а response равно 100, что представляет текущий баланс.

Ответ с ошибкой:

{
    "status": 0,
    "response": "ERROR_KEY"
}

Если возникла ошибка, status будет равно 0, а в поле response будет указан код ошибки (в данном случае ERROR_KEY).


Примеры использования

Python
import requests
url = "https://api.capsola.cloud/balance"
api_key = "API_KEY"
headers = {
    "Content-Type": "application/json",
    "X-API-Key": api_key
}
# Отправка запроса
response = requests.get(url, headers=headers)
# Обработка ответа
if response.status_code == 200:
    result = response.json()
    print("Баланс:", result["response"])
else:
    print("Произошла ошибка:", response.json()["response"])
PHP
$url = "https://api.capsola.cloud/balance";
$api_key = "API_KEY";
$headers = array(
    "Content-Type: application/json",
    "X-API-Key: " . $api_key
);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
if ($response === false) {
    echo "Ошибка Curl: " . curl_error($ch);
} else {
    $result = json_decode($response, true);
    if ($result["status"] === 1) {
        echo "Баланс: " . $result["response"];
    } else {
        echo "Произошла ошибка: " . $result["response"];
    }
}
curl_close($ch);
Nodejs
const url = "https://api.capsola.cloud/balance";
const apiKey = "API_KEY";
const headers = {
    "Content-Type": "application/json",
    "X-API-Key": apiKey
};
// Отправка запроса
fetch(url, {
    method: "GET",
    headers: headers
})
.then(response => response.json())
.then(result => {
    if (result.status === 1) {
        console.log("Баланс:", result.response);
    } else {
        console.log("Произошла ошибка:", result.response);
    }
})
.catch(error => console.error("Ошибка:", error));