Перед началом работы
Убедитесь, что:- В вашем аккаунте используется платный тарифный план YCloud. Пользовательские приложения недоступны на бесплатном плане Free.
- Ваша роль имеет доступ к разделу Developers > Custom apps в панели управления YCloud.
- Телефонные номера WhatsApp Business, необходимые приложению, уже добавлены в ваш аккаунт YCloud.
- Вы знаете, какие разрешения API требуются интеграции.
- У вас есть общедоступная конечная точка HTTPS, если приложению требуются события Webhook.
Создание приложения
- Войдите в панель управления YCloud.
- Перейдите в Developers > Custom apps.
- Нажмите Create app.

- Введите App name. Название может содержать до 64 символов.
- Необязательно: введите Description длиной до 512 символов, чтобы ваша команда понимала назначение приложения.
- Нажмите Create.

Enter an app name and, optionally, a description before selecting Create.
Назначение телефонных номеров WhatsApp
Назначайте только те телефонные номера, к которым интеграции необходим доступ.- Откройте приложение и выберите Assets.
- Нажмите Add phone numbers.

- Найдите номер по названию Business Manager, WABA ID, имени WABA или номеру телефона.
- Выберите один или несколько телефонных номеров WhatsApp Business.
- Нажмите Confirm.

Настройка API-ключа и разрешений
YCloud отображает API-ключ приложения в разделе API key & permissions. Ключи пользовательских приложений начинаются сyc_ak_. Скопируйте ключ, чтобы сохранить его в безопасном месте, а затем добавьте только те разрешения, которые требуются интеграции.

- Выберите API key & permissions.
- В подразделе API permissions нажмите Add permissions.
- Отфильтруйте по категории или выполните поиск по названию разрешения или области действия (scope).
- Выберите каждое необходимое разрешение. Например, разрешения для контактов разделены на области чтения, создания или обновления, а также удаления.
- Нажмите Confirm.

X-API-Key и используйте его только из доверенного серверного кода. YCloud проверяет, активно ли приложение и соответствует ли запрос одному из выбранных им разрешений API. Когда API работает с ресурсом WhatsApp, YCloud также проверяет, есть ли у приложения доступ к соответствующему номеру телефона или WABA.
Не все API YCloud доступны для пользовательских приложений. Запрос к API, отсутствующему в списке выбора разрешений, будет отклонен при использовании ключа пользовательского приложения. Ключи пользовательских приложений также нельзя сочетать с заголовком X-Managed-Account-ID.
Рекомендации по заголовкам запросов и работе с учетными данными см. в разделе Authentication.
Настройка вебхуков
Настройте отдельную точку назначения для событий, необходимых этому приложению. Вебхуки приложения функционируют отдельно от конечных точек Webhook, настроенных в разделе Developers > Webhooks.- Выберите Webhook.
- Введите вашу публичную конечную точку HTTPS в поле Endpoint URL и сохраните ее.
- Сохраните сгенерированный секрет Signing secret в безопасном месте.
- В подразделе Added events нажмите Add events.

- Отфильтруйте по категории или выполните поиск по названию или типу события.
- Выберите события, которые должна получать ваша конечная точка.
- Если для события предусмотрены параметры области данных (data-scope), выберите вариант, соответствующий вашей интеграции.
- Нажмите Confirm.

2xx. О проверке подписи, обработке доставки и рекомендациях по безопасности см. в разделе Configure webhooks. Схемы событий приведены в разделе Webhook event payloads.
Включение и проверка приложения
Перед использованием приложения в рабочей среде:- Убедитесь, что приложение содержит ожидаемые телефонные номера WhatsApp Business.
- Проверьте каждое разрешение API и отзовите доступ, который не требуется интеграции.
- Вернитесь в раздел Developers > Custom apps и включите приложение в меню действий.

- Убедитесь, что приложение находится в статусе Active.
- Отправьте тестовый запрос с ключом API приложения из безопасной серверной среды.
- Инициируйте выбранное событие и убедитесь, что ваш эндпоинт успешно проверяет и обрабатывает его.

