Что это такое
Balance API возвращает доступный баланс для аутентифицированного аккаунта YCloud. Используйте его для операционного мониторинга, оповещений о биллинге и проверки аутентификации.Перед началом работы
- Обеспечьте безопасное хранение вашего API-ключа YCloud.
- Определите, как часто вашему приложению требуются данные о балансе.
- Задайте пороговое значение для оповещений с учетом ожидаемого объема отправки.
Как это работает
Этот эндпоинт доступен только для чтения и всегда применяется к аккаунту, определенному по API-ключу. Он не принимает идентификатор аккаунта в пути или теле запроса. Используйте его в задачах мониторинга, а не перед отправкой каждого сообщения. Частые проверки баланса перед каждым сообщением увеличивают задержку и не резервируют средства.Запрос
GET /balance
Ответ
Рекомендации по мониторингу
- Настройте оповещения до того, как баланс достигнет уровня, способного прервать отправку рабочего трафика.
- Отображайте валюту в дашбордах и оповещениях.
- Используйте отдельное оповещение для сбоев API, чтобы недоступность проверки не принималась за нулевой баланс.
- Ограничьте доступ к данным о балансе как к конфиденциальной финансовой информации.
Лимиты и устранение неполадок
- Успешный ответ на запрос баланса подтверждает корректность API-ключа и базового URL.
- Низкий баланс может повлиять на работу тарифицируемых сервисов обмена сообщениями, даже если аутентификация API прошла успешно.
- Не предполагайте, что сумма указана в USD; проверяйте
currency. - Избегайте логирования API-ключа в журналах мониторинга.
Справочник Balance API
Изучите полную схему ответа и протестируйте запрос, доступный только для чтения.