> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ycloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Быстрый старт

> Пройдите аутентификацию в YCloud и выполните свой первый запрос к API.

В этом руководстве по быстрому старту вы вызовете Balance API, чтобы убедиться в правильности настройки базового URL и API-ключа.

## Перед началом работы

Вам понадобятся:

* Аккаунт YCloud
* API-ключ YCloud
* `curl` или другой HTTP-клиент

## Как это работает

Каждый серверный запрос к API использует базовый URL `https://api.ycloud.com/v2` и передает ваш ключ в заголовке `X-API-Key`. В этом примере запрашивается баланс аккаунта, так как при этом ничего не создается и не отправляется.

## Запрос

<Steps>
  <Step title="Сохраните свой API-ключ">
    Экспортируйте ключ в текущей сессии терминала. Замените плейсхолдер вашим реальным ключом.

    ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
    export YCLOUD_API_KEY="YOUR_API_KEY"
    ```

    Не фиксируйте API-ключи в системах контроля версий. Рекомендации для продакшена см. в разделе [Authentication](/ru/api-reference/guides/api-fundamentals/authentication).
  </Step>

  <Step title="Запросите баланс">
    Получите баланс вашего аккаунта.

    ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
    curl https://api.ycloud.com/v2/balance \
      --header "X-API-Key: $YCLOUD_API_KEY" \
      --header "Accept: application/json"
    ```
  </Step>
</Steps>

## Ответ

Успешный запрос возвращает HTTP `200` с вашим текущим балансом.

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "amount": 10.5,
  "currency": "USD"
}
```

| Поле | Описание |
| - | - |
| `amount` | Доступный баланс аккаунта. |
| `currency` | Валюта аккаунта по стандарту ISO. |

Если API возвращает `401` или `403`, проверьте имя заголовка и API-ключ. Ознакомьтесь с разделом [Handle errors](/ru/api-reference/guides/api-fundamentals/handle-errors), прежде чем настраивать повторные попытки запросов.

<Tip>Успешный ответ с балансом подтверждает корректную совместную работу базового URL и API-ключа.</Tip>

## Следующие шаги

<CardGroup cols={2}>
  <Card title="Отправьте сообщение в WhatsApp" icon="whatsapp" href="/ru/api-reference/guides/whatsapp-platform/send-whatsapp-message">
    Отправляйте шаблоны сообщений, текст и медиафайлы.
  </Card>

  <Card title="Настройте вебхуки" icon="webhook" href="/ru/api-reference/guides/api-fundamentals/configure-webhooks">
    Получайте статусы доставки и входящие сообщения.
  </Card>

  <Card title="Обрабатывайте ошибки API" icon="triangle-exclamation" href="/ru/api-reference/guides/api-fundamentals/handle-errors">
    Читайте ответы с ошибками и проектируйте безопасные повторные попытки.
  </Card>

  <Card title="Справочник по Balance API" icon="code" href="/api-reference/balance/retrieve-balance">
    Изучите полную схему ответа и протестируйте эндпоинт.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.