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

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

Вам понадобятся:
  • Аккаунт YCloud
  • API-ключ YCloud
  • curl или другой HTTP-клиент

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

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

​
Запрос

1

Сохраните свой API-ключ

Экспортируйте ключ в текущей сессии терминала. Замените плейсхолдер вашим реальным ключом.
Не фиксируйте API-ключи в системах контроля версий. Рекомендации для продакшена см. в разделе Authentication.
2

Запросите баланс

Получите баланс вашего аккаунта.

​
Ответ

Успешный запрос возвращает HTTP 200 с вашим текущим балансом.
Если API возвращает 401 или 403, проверьте имя заголовка и API-ключ. Ознакомьтесь с разделом Handle errors, прежде чем настраивать повторные попытки запросов.
Успешный ответ с балансом подтверждает корректную совместную работу базового URL и API-ключа.

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

Отправьте сообщение в WhatsApp

Отправляйте шаблоны сообщений, текст и медиафайлы.

Настройте вебхуки

Получайте статусы доставки и входящие сообщения.

Обрабатывайте ошибки API

Читайте ответы с ошибками и проектируйте безопасные повторные попытки.

Справочник по Balance API

Изучите полную схему ответа и протестируйте эндпоинт.