Поддержка клиентов
Русский
Как установить YCloud Developer Kit и создать интеграцию с WhatsApp API в Codex
Сколько усилий требуется для начала интеграции YCloud в Codex?
YCloud Developer Kit добавляет навыки интеграции, специфичные для YCloud, в Codex.
Чтобы продемонстрировать, как это работает, в этой статье используется фокусированный рабочий процесс подтверждения заказа через WhatsApp с имитацией данных.
Вы установите и проверите Kit, затем используете один запрос для планирования интеграции, её реализации локально и запуска имитационных тестов.
Для получения информации о поддерживаемых возможностях, рекомендациях по безопасности и соображениях для производства, прочитайте YCloud Developer Kit: Создание и тестирование интеграций WhatsApp API с помощью Codex.
Как установить YCloud Developer Kit в Codex
Шаг 1: Откройте YCloud Developer Kit
Выберите Установить или Попробовать сейчаси подтвердите, что Kit включен в среде Codex, где вы планируете его использовать.
Шаг 2: Установите Kit в вашем проекте Codex
Откройте целевой проект в Codex и выполните:
npx skills add YCloud-Developers/YCloud-Developer-Kit --skill '*' -a codex --copy -yЭта команда устанавливает навыки YCloud в текущем проекте. После установки запустите новую сессию Codex, чтобы она могла обнаружить новые установленные навыки.
Шаг 3: Проверка установки
В новой задаче Codex введите:
Use $ycloud-developer-kit-smoke-test to check whether the plugin is ready.Ожидаемый ответ:
YCloud Developer Kit is ready. No external API was called.Это подтверждает, что Codex может найти и использовать Kit. Это не проверяет учетные данные YCloud и не отправляет сообщение WhatsApp.
После успешного завершения smoke test Kit готов к работе над определенным требованием интеграции.
Как создать интеграцию подтверждения заказа через WhatsApp
Что мы создаем?
Рассмотрим процесс подтверждения заказа:
- Клиент оформляет заказ.
- Бэкенд подготавливает подтверждение через WhatsApp.
- Сообщение связывается с заказом.
- Последующие события доставки или сбоя обновляют запись уведомления.
Для этого примера приложение использует Node.js, Express и SQLite. Все заказы, ответы YCloud и события Webhook являются симуляцией.
Маркетинговые рассылки, входящие сообщения и управление кампаниями не входят в этот пример.
Шаг 1: Описание требования в Codex
Вместо выбора отдельных API или навыков начните с описания полного бизнес-процесса:
Use $ycloud-integration-architect to build a local WhatsApp
order-confirmation integration.
Our backend uses Node.js, Express and SQLite.
When a customer places an order:
- Prepare a WhatsApp order-confirmation message
- Associate the message with the order
- Process later delivery or failure events
- Prevent duplicate Webhook events from causing repeated updates
Implement the workflow in the current local project and add tests.
Use fictional orders and simulated YCloud responses.
Do not read real credentials or call real APIs.
After completing the work, provide:
1. The integration flow
2. Changed files
3. Configuration placeholders
4. Executed tests and actual results
5. Items that still require verification with YCloudОдин запрос определяет бизнес-цель, технологический стек, необходимый процесс, разрешенные действия, тестовые сценарии и ожидаемый результат.
Шаг 2: Просмотр сгенерированного плана
Codex сначала сопоставляет бизнес-требования с необходимыми компонентами интеграции.
Для этого рабочего процесса план должен включать:
- Создание заказа как триггер
- Подготовка и отправка сообщения WhatsApp
- Связь между записью заказа и сообщения
- Обработка Webhook статуса сообщения
- Обработка дублирующихся событий
- Обработка сбоев и тайм-аутов
- Требования к учетной записи, номеру телефона и шаблону
Ознакомьтесь с этими пунктами, чтобы подтвердить, что предлагаемый рабочий процесс соответствует требованиям приложения.
Шаг 3: Разрешите Codex реализовать рабочий процесс
Поскольку подсказка разрешает изменения текущего локального проекта, Codex может реализовать определенный рабочий процесс и добавить его тесты.
Сгенерированная реализация может включать:
- Логику подтверждения заказа
- Адаптер запросов YCloud
- Заполнители конфигурации
- Корреляцию сообщения с заказом
- Приемник Webhook
- Логику обработки статуса
- Локальные тесты
- Инструкции для запуска
После реализации Codex должен перечислить каждый созданный или измененный файл. Это дает разработчикам четкое резюме работы, которую необходимо просмотреть.
Шаг 4: Запустите симулированные тесты
Важно: Этот пример использует симулированные ответы YCloud и синтетические события Webhook. Он не подключается к реальному аккаунту YCloud и не отправляет настоящее сообщение WhatsApp.
Локальные тесты охватывают:
- Успешную отправку запроса
- Отклонение API
- Поздний статус неудачного сообщения
- Тайм-аут запроса
- Дублирующееся событие статуса
- Неверный Webhook
Записанный результат был:
24 tests passed
0 failed
0 skippedЭти результаты подтверждают, что определенные локальные сценарии дали ожидаемые результаты.
Они также показывают, что:
- Отправка запроса и последующие статусы сообщений хранятся отдельно.
- Дублирующиеся события не вызывают повторных бизнес-обновлений.
- Истекший по времени запрос остается неопределенным.
- Приложение не отправляет данные повторно автоматически после истечения времени ожидания.
Результаты относятся только к протестированным смоделированным сценариям.
Шаг 5: Определите, что осталось до релиза
Codex также может разделить завершенную локальную работу от задач, которые требуют авторизованной среды YCloud:
- Настройте учетную запись YCloud и номер WhatsApp.
- Подтвердите утвержденный шаблон сообщения.
- Добавьте серверный API-ключ.
- Настройте публичную конечную точку Webhook.
- Протестируйте реальные запросы и коллбэки статусов.
- Завершите проверку кода, мониторинг и развертывание.
Локальный рабочий процесс теперь реализован и протестирован на определенных симуляциях.
Оставшаяся работа выполняется в авторизованной среде YCloud и окружении развертывания команды.
Что демонстрирует этот пример?
YCloud Developer Kit помогает перенести определенное бизнес-требование через планирование, локальную реализацию, тестирование и техническую передачу в рамках Codex.
Входные данные | Результат |
| Один определенный бизнес-процесс | Структурированный план интеграции |
| Один запрос на реализацию | Локальные кодовые и конфигурационные заглушки |
| Определенные сценарии тестирования | Записанные результаты нормального и аварийного выполнения |
| Один запрос на передачу | Оставшиеся требования YCloud и развертывания |
Это позволяет разработчикам пройти полный процесс интеграции без необходимости вручную определять каждую возможность YCloud или шаг реализации.
Заключение
YCloud Developer Kit предоставляет прямой путь от установки до локальной разработки интеграции. Установите и проверьте комплект, опишите один бизнес-процесс четко, и позвольте Codex спланировать, реализовать и протестировать его в рамках проекта.
Настройка аккаунта, развертывание в продакшене и проверка в реальной среде остаются отдельными шагами.
Для полного списка возможностей, уровней валидации, практик безопасности и рекомендаций для продакшена читайте YCloud Developer Kit: Создание и тестирование интеграций WhatsApp API с Codex.
Начните разработку с YCloud Developer Kit
Установите YCloud Developer Kit, создайте новую задачу в Codex и опишите рабочий процесс WhatsApp, который хотите реализовать.
Узнайте больше о YCloud Developer Kit ЗДЕСЬ
Frequently Asked Questions
YCloud Developer Kit — это то же самое, что и YCloud Dashboard?
Нет. YCloud Developer Kit — это помощник для разработки интеграций, используемый в Codex. Операции с сообщениями и управление кампаниями используют отдельные инструменты.
Установка комплекта подключает его к аккаунту YCloud?
Нет. Доступ к аккаунту YCloud, учетные данные и внешние ресурсы должны быть настроены отдельно.
Может ли отправлять настоящие WhatsApp-сообщения?
Не сам по себе.
Версия 0.7.9 может помочь разработчикам писать код приложений, который отправляет сообщения через YCloud. Однако Kit не считывает реальные учетные данные, не вызывает API YCloud и не отправляет реальные сообщения во время своего рабочего процесса. Фактическая отправка происходит отдельно через настроенное приложение в авторизованной среде.
Нужно ли разработчикам предоставлять API-ключ на этапе планирования?
Нет. При планировании, примерах кода и имитационном тестировании можно использовать заглушки и синтетические данные.
Может ли он изменить существующий проект?
Да. Разработчик должен явно авторизовать изменения локальных файлов и определить проект, модули и разрешенную область.
Означает ли успешное тестирование интеграцию готовую к продакшену?
Нет. Симуляция проверяет только определенные локальные сценарии. Настройка для производства и тестирование с YCloud по-прежнему необходимы.
Может ли это помочь в обработке входящих сообщений?
Да. Это может помочь реализовать обработчики вебхуков, которые проверяют и направляют входящие сообщения к бизнес-логике приложения.
Поддерживает ли он шаблоны, контакты и управление отписками?
Да. Версия 0.7.9 включает специальные рекомендации для шаблонов, контактов и процессов отписки.
Поддерживает ли он SMS, голосовые звонки, Verify или Email?
Интеграции SMS, Verify, YCloud Voice и Email не входят в заявленный объем версии 0.7.9.
WhatsApp Calling поддерживается и отделен от YCloud Voice.
Что делать, если официальную документацию API невозможно проверить?
Пометьте пример как неподтвержденный и выделите конечные точки, поля или поведение, которые все еще требуют подтверждения.
Если Kit возвращает:
"synthetic_unverified"
Это означает, что результат был получен с использованием синтетических данных, а заявленные детали контракта не были полностью подтверждены. Это не статус API YCloud и не свидетельство реального тестирования интеграции.
Связанные статьи
Сделайте ваши бизнес-коммуникации намного проще
Доверенный
