Skip to main content

Получение API-ключа

YCloud выполняет аутентификацию серверных запросов с помощью API-ключей. Создайте или просмотрите API-ключ в разделе Панель управления > Разработчикам > API-ключи, а затем передавайте его в заголовке запроса X-API-Key.
Храните API-ключи на своем сервере. Никогда не фиксируйте их в репозитории и не раскрывайте в коде браузера или мобильного приложения.
Если вы предпочитаете использовать SDK, ознакомьтесь со списком доступных языков и инструкциями по установке в разделе YCloud Developers.

Изучение эндпоинта

Откройте страницу Отправка SMS, чтобы ознакомиться с полным списком параметров запроса, схемой ответа и интерактивным конструктором запросов. Подробные сведения о полном процессе интеграции и нюансах доставки см. в разделе Отправка SMS.

Обработка ответа

Ответ 2xx означает, что YCloud принял запрос. Это не обязательно означает, что SMS уже доставлено получателю. Сохраните возвращенный ID сообщения и сопоставляйте его с результатами запросов или событиями webhook для отслеживания доставки.

Обработка ошибок

Ответы с ошибками содержат три поля:
  • code — стабильный машиночитаемый идентификатор ошибки.
  • message содержит пояснение ошибки для разработчиков.
  • requestId помогает службе поддержки YCloud при диагностике запроса.
Используйте стабильный идентификатор ошибки в логике вашего приложения. Не привязывайтесь к тексту пояснения для разработчиков. См. раздел Обработка ошибок для ознакомления с форматом ответа и рекомендациями по повторным попыткам.