> ## 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.

# Интерфейс API

> Аутентифицируйтесь с помощью API-ключа и отправляйте сообщения SMS через YCloud API.

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

YCloud выполняет аутентификацию серверных запросов с помощью API-ключей. Создайте или просмотрите API-ключ в разделе [**Панель управления > Разработчикам > API-ключи**](https://www.ycloud.com/console/#/app/developers/apikey), а затем передавайте его в заголовке запроса `X-API-Key`.

<Warning>
  Храните API-ключи на своем сервере. Никогда не фиксируйте их в репозитории и не раскрывайте в коде браузера или мобильного приложения.
</Warning>

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl --request POST 'https://api.ycloud.com/v2/sms' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "to": "+16315551234",
    "text": "Your verification code is 123456."
  }'
```

Если вы предпочитаете использовать SDK, ознакомьтесь со списком доступных языков и инструкциями по установке в разделе [YCloud Developers](https://github.com/ycloud-developers).

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

Откройте страницу [Отправка SMS](/api-reference/sms/send-an-sms), чтобы ознакомиться с полным списком параметров запроса, схемой ответа и интерактивным конструктором запросов. Подробные сведения о полном процессе интеграции и нюансах доставки см. в разделе [Отправка SMS](/ru/api-reference/guides/messaging/send-sms).

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

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

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

Ответы с ошибками содержат три поля:

* `code` — стабильный машиночитаемый идентификатор ошибки.
* `message` содержит пояснение ошибки для разработчиков.
* `requestId` помогает службе поддержки YCloud при диагностике запроса.

Используйте стабильный идентификатор ошибки в логике вашего приложения. Не привязывайтесь к тексту пояснения для разработчиков. См. раздел [Обработка ошибок](/ru/api-reference/guides/api-fundamentals/handle-errors) для ознакомления с форматом ответа и рекомендациями по повторным попыткам.


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