Ръководство за интеграция със Stripe Apps
Stripe Apps Ви позволяват да вграждате персонализирана функционалност директно в таблото на Stripe. Този раздел е ръководство за изграждане: той описва как такова приложение за интеграцията между Tajo и Brevo би било изградено, тествано и публикувано.
Caution
Статус: планирано, не е изградено. Tajo няма приложение за Stripe, така че нищо в този раздел не може да бъде инсталирано днес, а идентификаторите на приложения, адресите и идентификационните данни в тези страници са илюстративни примери, а не действащи крайни точки. За да свържете Stripe с Tajo още сега, използвайте конектора за Stripe (ограничен API ключ, синхронизация само за четене).
Tip
Целта е да се публикува интеграция с Brevo в Stripe App Marketplace, която да позволи на търговците в Stripe да синхронизират клиентски данни, поръчки и събития директно в Brevo за маркетингова автоматизация и CRM.
Какво представляват Stripe Apps?
Stripe Apps разширяват таблото на Stripe с персонализирани компоненти на интерфейса и интеграции от страна на сървъра. Те позволяват на външните разработчици:
- Да добавят персонализирани изгледи към страниците в таблото на Stripe (клиенти, плащания, фактури и други)
- Да достъпват данни от Stripe чрез ограничени по обхват права
- Да синхронизират данни между Stripe и външни платформи като Brevo
- Да предоставят потоци за въвеждане в работа и конфигуриране в самото табло
Цели на интеграцията между Tajo и Brevo
Приложението на Tajo за Stripe свързва Stripe с Brevo, за да достави:
- Интелигентност за клиентите: синхронизация на клиентските профили, историята на плащанията и стойността за целия живот от Stripe към контактите в Brevo
- Проследяване на събития: изпращане на събитията от Stripe (плащания, абонаменти, възстановявания) като транзакционни събития в Brevo
- Автоматизирани кампании: задействане на имейл, SMS и WhatsApp кампании в Brevo на база активността в Stripe
- Програми за лоялност: изграждане на работни процеси за задържане с данни за покупките от Stripe, синхронизирани към Brevo
Общ преглед на архитектурата
- Табло на Stripeинтерфейс на Stripe приложениетоИзгледи на клиентиДетайли за плащанеНастройки на приложението
- Tajoмеждинен слойСинхронизация на данниМаршрутизиране на събитияОбработка на webhooks
- BrevoCRM и имейлКонтактиКампанииАвтоматизации
Съдържание на ръководството
Тази документация покрива целия жизнен цикъл на изграждането и публикуването на едно Stripe приложение:
Първи стъпки
| Ръководство | Описание |
|---|---|
| Публикуване в Marketplace | Изисквания и стъпки за подаване на приложението Ви за преглед |
| Изисквания за преглед на приложението | Стандарти за качество, сигурност и потребителско изживяване при одобрение |
Конфигурация и справочници
| Ръководство | Описание |
|---|---|
| Справочник за App Manifest | Пълната схема на файла stripe-app.json |
| Справочник за правата | Пълен списък с правата за Stripe API и как да ги заявите |
| Справочник за Viewports | Местата в таблото, където може да се появи интерфейсът на приложението Ви |
Функции и интеграция
| Ръководство | Описание |
|---|---|
| Вградени Stripe приложения | Използване на вградените компоненти на Connect за платформени интеграции |
| Връзки за инсталиране и дълбоки връзки | Генериране на адреси за инсталиране и дълбоки връзки към конкретни изгледи |
| Действия след инсталиране | Конфигуриране на потоци за въвеждане в работа след инсталирането |
Експлоатация и растеж
| Ръководство | Описание |
|---|---|
| Анализи за приложението | Проследяване на инсталации, прегледи и показатели за конверсия |
Предварителни изисквания
Преди да изградите Stripe приложение, уверете се, че разполагате с:
- Акаунт в Stripe: активиран акаунт в Stripe (не ограничен до тестов режим)
- Stripe CLI: инсталирайте Stripe CLI за локална разработка и качване на приложения
- Node.js: версия 16 или по-нова за разширението на интерфейса
- Достъп до платформата 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Основни понятия
App Manifest
Всяко Stripe приложение има файл stripe-app.json, който декларира права, viewports и конфигурация. Вижте справочника за App Manifest за пълната схема.
Разширения на интерфейса
Stripe приложенията могат да визуализират компоненти на интерфейса на база React в конкретни viewports на таблото. Наборът от инструменти за интерфейс предоставя готови компоненти, които съответстват на дизайн системата на таблото на Stripe.
Права
Приложенията трябва да декларират конкретните ресурси от Stripe API, до които им е нужен достъп. Потребителите одобряват тези права по време на инсталирането. Вижте справочника за правата.
Подписващ ключ
Всяко приложение получава подписващ ключ за проверка на подписите при инсталиране и за защита на комуникацията между Вашия сървър и Stripe.
Работен процес на разработка
- Дефинирайте своя manifest с необходимите права и viewports
- Изградете разширението на интерфейса с библиотеката с React компоненти на Stripe
- Реализирайте сървърните крайни точки за синхронизация на данни с Brevo през Tajo
- Тествайте локално с
stripe apps start - Качете с
stripe apps upload - Подайте за преглед през таблото на Stripe
- Публикувайте и следете чрез анализите
Caution
Stripe изисква приложенията да са написани на английски за разпространение в marketplace. Описанието на приложението Ви, текстът в интерфейса и документацията трябва да са изцяло на английски.
Следващи стъпки
Започнете с ръководството за публикуване, за да разберете пълните изисквания, и след това преминете през техническите справочници, за да конфигурирате manifest файла и правата на приложението си.