Руководство по интеграции Stripe Apps
Stripe Apps позволяют встраивать собственную функциональность прямо в Stripe Dashboard. Этот раздел представляет собой руководство по разработке: он описывает, как такое приложение для интеграции Tajo и Brevo было бы создано, протестировано и опубликовано.
Caution
Статус: пока не опубликовано. Сегодня в Stripe App Marketplace нет приложения Tajo, а идентификаторы приложения, URL и учётные данные на этих страницах являются иллюстративными заглушками, а не рабочими эндпоинтами. Чтобы подключить Stripe к Tajo прямо сейчас, используйте коннектор Stripe (ограниченный API-ключ, синхронизация только на чтение).
Tip
Цель: опубликовать интеграцию с Brevo в Stripe App Marketplace, чтобы продавцы на Stripe могли синхронизировать данные клиентов, заказы и события напрямую в Brevo для маркетинговой автоматизации и CRM.
Что такое Stripe Apps?
Stripe Apps расширяют Stripe Dashboard собственными UI-компонентами и серверными интеграциями. Они позволяют сторонним разработчикам:
- Добавлять собственные представления на страницы Stripe Dashboard (клиенты, платежи, счета и так далее)
- Получать доступ к данным Stripe через ограниченные разрешения
- Синхронизировать данные между Stripe и внешними платформами, такими как Brevo
- Предоставлять сценарии онбординга и настройки внутри Dashboard
Цели интеграции Tajo и Brevo
Приложение Tajo для Stripe связывает Stripe с Brevo, чтобы обеспечить:
- Аналитика клиентов: синхронизация профилей клиентов Stripe, истории платежей и пожизненной ценности в контакты Brevo
- Отслеживание событий: передача событий Stripe (платежи, подписки, возвраты) как транзакционных событий Brevo
- Автоматизированные кампании: запуск email-, SMS- и WhatsApp-кампаний Brevo на основе активности в Stripe
- Программы лояльности: построение рабочих процессов удержания на данных о покупках из Stripe, синхронизированных в Brevo
Обзор архитектуры
Содержание руководства
Эта документация охватывает полный жизненный цикл создания и публикации приложения Stripe:
Начало работы
| Guide | Description |
|---|---|
| Публикация в Marketplace | Требования и шаги для отправки приложения на проверку |
| Требования к проверке приложения | Стандарты качества, безопасности и UX для одобрения |
Настройка и справочники
| Guide | Description |
|---|---|
| Справочник по манифесту приложения | Полная схема файла манифеста stripe-app.json |
| Справочник по разрешениям | Полный список разрешений Stripe API и порядок их запроса |
| Справочник по viewport | Места в Dashboard, где может отображаться интерфейс вашего приложения |
Возможности и интеграция
| Guide | Description |
|---|---|
| Встроенные Stripe Apps | Использование встроенных компонентов Connect для платформенных интеграций |
| Ссылки установки и глубокие ссылки | Генерация URL установки и переходы к конкретным экранам приложения |
| Действия после установки | Настройка сценариев онбординга после установки приложения |
Эксплуатация и рост
| Guide | Description |
|---|---|
| Аналитика приложения | Отслеживание установок, просмотров и метрик конверсии |
| Партнёрская экосистема | Использование партнёрской программы Stripe для совместного маркетинга и роста |
Предварительные требования
Перед созданием приложения Stripe убедитесь, что у вас есть:
- Аккаунт Stripe: активированный аккаунт Stripe (не ограниченный тестовым режимом)
- Stripe CLI: установите Stripe CLI для локальной разработки и загрузки приложений
- Node.js: версия 16 или новее для UI-расширения приложения
- Доступ к платформе Tajo: активный аккаунт Tajo с настроенными учётными данными Brevo API
Быстрый старт
# 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Ключевые понятия
Манифест приложения
Каждое приложение Stripe имеет манифест stripe-app.json, который объявляет разрешения, viewport и конфигурацию. Полную схему смотрите в справочнике по манифесту приложения.
UI-расширения
Stripe Apps могут отрисовывать UI-компоненты на React в определённых viewport Dashboard. Набор UI-инструментов даёт готовые компоненты, соответствующие дизайн-системе Stripe Dashboard.
Разрешения
Приложения должны объявлять конкретные ресурсы Stripe API, к которым им нужен доступ. Пользователи одобряют эти разрешения при установке. Смотрите справочник по разрешениям.
Секрет подписи
Каждое приложение получает секрет подписи для проверки подписей установки и защиты обмена данными между вашим бэкендом и Stripe.
Процесс разработки
- Определите манифест с нужными разрешениями и viewport
- Соберите UI-расширение с помощью библиотеки React-компонентов Stripe
- Реализуйте серверные эндпоинты для синхронизации данных с Brevo через Tajo
- Протестируйте локально с помощью
stripe apps start - Загрузите приложение командой
stripe apps upload - Отправьте приложение на проверку через Stripe Dashboard
- Опубликуйте приложение и следите за показателями в аналитике
Caution
Stripe требует, чтобы приложения для распространения в marketplace были на английском языке. Описание приложения, текст интерфейса и документация должны быть на английском.
Дальнейшие шаги
Начните с руководства по публикации, чтобы понять все требования, а затем изучите технические справочники, чтобы настроить манифест и разрешения приложения.