Руководство по интеграции Stripe Apps
Stripe Apps позволяет встраивать пользовательский функционал непосредственно в Stripe Dashboard, предоставляя продавцам доступ к интеграции Tajo с Brevo без выхода из рабочего процесса платежей. Это руководство охватывает всё необходимое для создания, тестирования и публикации Stripe App, соединяющего Stripe с Brevo через Tajo.
Tip
Цель, опубликовать интеграцию Brevo в Stripe App Marketplace, чтобы продавцы Stripe могли синхронизировать данные покупателей, заказы и события напрямую в Brevo для маркетинговой автоматизации и CRM.
Что такое Stripe Apps?
Stripe Apps расширяют Stripe Dashboard пользовательскими UI-компонентами и серверными интеграциями. Они позволяют сторонним разработчикам:
- Добавлять пользовательские представления на страницы Stripe Dashboard (покупатели, платежи, счета и т.д.)
- Получать доступ к данным Stripe через разрешения с ограниченной областью
- Синхронизировать данные между Stripe и внешними платформами, такими как Brevo
- Предоставлять онбординг и конфигурационные потоки внутри Dashboard
Цели интеграции Tajo + Brevo
Stripe App Tajo соединяет Stripe с Brevo для:
- Клиентской аналитики: Синхронизация профилей покупателей, истории платежей и пожизненной ценности из Stripe в контакты Brevo
- Отслеживания событий: Передача событий Stripe (платежи, подписки, возвраты) как транзакционных событий Brevo
- Автоматизированных кампаний: Запуск email, SMS и WhatsApp-кампаний Brevo на основе активности в Stripe
- Программ лояльности: Создание процессов удержания с использованием данных о покупках Stripe, синхронизированных с Brevo
Обзор архитектуры
┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐│ Stripe Dashboard │────▶│ Tajo Platform │────▶│ Brevo ││ (Stripe App UI) │◀────│ (Middleware) │◀────│ (CRM/Email) │└─────────────────┘ └─────────────────┘ └─────────────────┘ │ │ │ Представления Синхронизация & Контакты, покупателей маршрутизация Кампании, Детали платежей событий Автоматизации Настройки app Обработка вебхуковСодержание руководства
Эта документация охватывает полный жизненный цикл создания и публикации Stripe App:
Начало работы
| Руководство | Описание |
|---|---|
| Публикация на Marketplace | Требования и шаги для отправки приложения на проверку |
| Требования к проверке приложения | Стандарты качества, безопасности и UX для одобрения |
Конфигурация и справочник
| Руководство | Описание |
|---|---|
| Справочник App Manifest | Полная схема файла манифеста stripe-app.json |
| Справочник разрешений | Полный список разрешений Stripe API и способы их запроса |
| Справочник вьюпортов | Места в Dashboard, где может отображаться UI вашего приложения |
Функции и интеграция
| Руководство | Описание |
|---|---|
| Встроенные Stripe Apps | Использование встроенных компонентов Connect для интеграции платформ |
| Ссылки установки и глубокие ссылки | Создание URL установки и глубоких ссылок на определённые представления приложения |
| Действия после установки | Настройка онбординг-потоков после установки приложения |
Операции и рост
| Руководство | Описание |
|---|---|
| Аналитика приложения | Отслеживание установок, просмотров и метрик конверсии |
| Партнёрская экосистема | Использование партнёрской программы Stripe для совместного маркетинга и роста |
Предварительные требования
Перед созданием Stripe App убедитесь, что у вас есть:
- Аккаунт Stripe: Активированный аккаунт Stripe (не ограниченный режимом тестирования)
- Stripe CLI: Установите Stripe CLI для локальной разработки и загрузки приложений
- Node.js: Версия 16 или выше для UI-расширения приложения
- Доступ к платформе Tajo: Активный аккаунт Tajo с настроенными API-учётными данными Brevo
Быстрый старт
# Install Stripe CLIbrew install stripe/stripe-cli/stripe
# Login to your Stripe accountstripe login
# Create a new Stripe App projectstripe apps create tajo-brevo-integration
# Start local developmentstripe apps startКлючевые концепции
App Manifest
Каждый Stripe App имеет манифест stripe-app.json, объявляющий разрешения, вьюпорты и конфигурацию. См. справочник App Manifest для полной схемы.
UI-расширения
Stripe Apps могут рендерить React-компоненты в определённых вьюпортах Dashboard. UI-инструментарий предоставляет готовые компоненты, соответствующие дизайн-системе Stripe Dashboard.
Разрешения
Приложения должны декларировать конкретные ресурсы Stripe API, к которым им нужен доступ. Пользователи одобряют эти разрешения при установке. См. справочник разрешений.
Signing Secret
Каждое приложение получает signing secret для проверки подписей установки и защиты коммуникации между бэкендом и Stripe.
Рабочий процесс разработки
- Определите манифест с необходимыми разрешениями и вьюпортами
- Создайте UI-расширение с использованием библиотеки React-компонентов Stripe
- Реализуйте серверные эндпоинты для синхронизации данных с Brevo через Tajo
- Протестируйте локально с помощью
stripe apps start - Загрузите с помощью
stripe apps upload - Отправьте на проверку через Stripe Dashboard
- Опубликуйте и ведите мониторинг через аналитику
Caution
Stripe требует, чтобы приложения были написаны на английском языке для распространения на маркетплейсе. Листинг приложения, текст UI и документация должны быть на английском.
Следующие шаги
Начните с руководства по публикации для понимания полных требований, затем изучите технические справочники для настройки манифеста и разрешений приложения.