Solicită acces anticipat

Spune-ne prenumele și o adresă de e-mail sau un număr de telefon. Îți vom trimite detaliile de acces la Tajo.

Referință pentru viewporturi

Viewporturile stabilesc unde apar componentele de interfață ale aplicației tale Stripe în Stripe Dashboard. Fiecare viewport corespunde unei anumite pagini sau zone din Dashboard, în care aplicația ta poate afișa o vizualizare.

Cum funcționează viewporturile

Când declari o vizualizare în manifestul aplicației, asociezi o componentă React unui viewport:

{
"ui_extension": {
"views": [
{
"viewport": "stripe.dashboard.customer.detail",
"component": "CustomerDetailView"
}
]
}
}

Componenta se afișează în sertarul aplicației (panoul lateral) atunci când un utilizator ajunge pe pagina corespunzătoare din Dashboard și deschide aplicația ta.

Viewporturi la nivel de Dashboard față de viewporturi specifice unei pagini

Viewporturi la nivel de Dashboard

Aceste viewporturi sunt disponibile pe fiecare pagină din Stripe Dashboard:

ID viewportDescriere
stripe.dashboard.drawer.defaultVizualizarea implicită din sertar, accesibilă de pe orice pagină din Dashboard prin pictograma aplicației
stripe.dashboard.home.overviewPrezentarea generală de pe pagina principală, afișată pe pagina de start a Dashboardului
stripe.dashboard.settingsPagina de setări a aplicației, accesibilă din meniul de setări al aplicației
stripe.dashboard.onboardingFluxul de inițiere, afișat după instalarea aplicației

Tip

Viewportul drawer.default funcționează ca variantă de rezervă. Dacă un utilizator deschide aplicația pe o pagină pentru care nu ai declarat un viewport anume, se afișează în schimb vizualizarea drawer.default.

Viewporturi specifice unei pagini

Aceste viewporturi se afișează doar atunci când utilizatorul se află pe pagina corespunzătoare din Dashboard:

Plăți

ID viewportPaginăTipar URLTip de obiect
stripe.dashboard.payment.listLista de plăți/payments
stripe.dashboard.payment.detailDetaliile plății/payments/:idPaymentIntent
stripe.dashboard.charge.detailDetaliile încasării/payments/:id (versiune veche)Charge

Clienți

ID viewportPaginăTipar URLTip de obiect
stripe.dashboard.customer.listLista de clienți/customers
stripe.dashboard.customer.detailDetaliile clientului/customers/:idCustomer

Produse și prețuri

ID viewportPaginăTipar URLTip de obiect
stripe.dashboard.product.listLista de produse/products
stripe.dashboard.product.detailDetaliile produsului/products/:idProduct
stripe.dashboard.price.detailDetaliile prețului/prices/:idPrice

Facturi

ID viewportPaginăTipar URLTip de obiect
stripe.dashboard.invoice.listLista de facturi/invoices
stripe.dashboard.invoice.detailDetaliile facturii/invoices/:idInvoice

Abonamente

ID viewportPaginăTipar URLTip de obiect
stripe.dashboard.subscription.listLista de abonamente/subscriptions
stripe.dashboard.subscription.detailDetaliile abonamentului/subscriptions/:idSubscription

Finalizarea comenzii

ID viewportPaginăTipar URLTip de obiect
stripe.dashboard.checkout.session.listLista sesiunilor Checkout/checkout/sessions
stripe.dashboard.checkout.session.detailDetaliile sesiunii Checkout/checkout/sessions/:idCheckoutSession
stripe.dashboard.payment-link.listLista linkurilor de plată/payment-links
stripe.dashboard.payment-link.detailDetaliile linkului de plată/payment-links/:idPaymentLink

Connect

ID viewportPaginăTipar URLTip de obiect
stripe.dashboard.connect.account.listLista conturilor conectate/connect/accounts
stripe.dashboard.connect.account.detailDetaliile contului conectat/connect/accounts/:idAccount
stripe.dashboard.transfer.listLista transferurilor/connect/transfers
stripe.dashboard.transfer.detailDetaliile transferului/connect/transfers/:idTransfer

Facturare

ID viewportPaginăTipar URLTip de obiect
stripe.dashboard.coupon.listLista cupoanelor/coupons
stripe.dashboard.coupon.detailDetaliile cuponului/coupons/:idCoupon
stripe.dashboard.quote.listLista ofertelor/quotes
stripe.dashboard.quote.detailDetaliile ofertei/quotes/:idQuote
stripe.dashboard.credit-note.detailDetaliile notei de credit/credit-notes/:idCreditNote

Plăți către cont

ID viewportPaginăTipar URLTip de obiect
stripe.dashboard.payout.listLista plăților către cont/payouts
stripe.dashboard.payout.detailDetaliile plății către cont/payouts/:idPayout

Dispute

ID viewportPaginăTipar URLTip de obiect
stripe.dashboard.dispute.listLista disputelor/disputes
stripe.dashboard.dispute.detailDetaliile disputei/disputes/:idDispute

Terminal

ID viewportPaginăTipar URLTip de obiect
stripe.dashboard.terminal.reader.listLista cititoarelor/terminal/readers
stripe.dashboard.terminal.reader.detailDetaliile cititorului/terminal/readers/:idTerminalReader
stripe.dashboard.terminal.location.listLista locațiilor/terminal/locations
stripe.dashboard.terminal.location.detailDetaliile locației/terminal/locations/:idTerminalLocation

Issuing

ID viewportPaginăTipar URLTip de obiect
stripe.dashboard.issuing.card.listLista cardurilor/issuing/cards
stripe.dashboard.issuing.card.detailDetaliile cardului/issuing/cards/:idIssuingCard
stripe.dashboard.issuing.cardholder.listLista deținătorilor de card/issuing/cardholders
stripe.dashboard.issuing.cardholder.detailDetaliile deținătorului de card/issuing/cardholders/:idIssuingCardholder
stripe.dashboard.issuing.transaction.listLista tranzacțiilor/issuing/transactions
stripe.dashboard.issuing.authorization.listLista autorizărilor/issuing/authorizations

Accesarea contextului obiectului

Când aplicația ta se afișează într-un viewport de detaliu, primește drept context obiectul Stripe corespunzător:

import type { ExtensionContextValue } from '@stripe/ui-extension-sdk/context';
const CustomerDetailView = ({ environment }: ExtensionContextValue) => {
const { objectContext } = environment;
// objectContext contains the current Stripe object
const customerId = objectContext?.id; // "cus_xxxxx"
const customerEmail = objectContext?.email;
return (
<Box>
<Inline>Customer: {customerEmail}</Inline>
<Inline>Brevo Sync Status: checking...</Inline>
</Box>
);
};

Context în listă față de context în detaliu

Tip de viewportContextul obiectuluiCând îl folosești
Listă (de exemplu, customer.list)Indisponibil, nu este selectat niciun obiect anumeAfișează date agregate, vizualizări de tip rezumat sau acțiuni în masă
Detaliu (de exemplu, customer.detail)Obiectul Stripe complet pentru pagina curentăAfișează date, acțiuni și integrări specifice obiectului

Viewporturi recomandate pentru integrarea Tajo cu Brevo

Pentru aplicația de integrare Tajo cu Brevo, aceste viewporturi aduc cea mai mare valoare:

{
"ui_extension": {
"views": [
{
"viewport": "stripe.dashboard.customer.detail",
"component": "CustomerDetailView"
},
{
"viewport": "stripe.dashboard.customer.list",
"component": "CustomerListView"
},
{
"viewport": "stripe.dashboard.payment.detail",
"component": "PaymentDetailView"
},
{
"viewport": "stripe.dashboard.subscription.detail",
"component": "SubscriptionDetailView"
},
{
"viewport": "stripe.dashboard.home.overview",
"component": "OverviewView"
},
{
"viewport": "stripe.dashboard.drawer.default",
"component": "DrawerView"
},
{
"viewport": "stripe.dashboard.settings",
"component": "SettingsView"
},
{
"viewport": "stripe.dashboard.onboarding",
"component": "OnboardingView"
}
]
}
}
ComponentăRol
CustomerDetailViewAfișează informațiile de contact din Brevo, starea sincronizării și datele de interacțiune pentru un anumit client
CustomerListViewAfișează comenzile de sincronizare în masă și statisticile agregate ale sincronizării cu Brevo
PaymentDetailViewAfișează ce evenimente Brevo au fost declanșate de această plată
SubscriptionDetailViewAfișează starea automatizărilor Brevo pentru acest abonament
OverviewViewWidget pe pagina principală din Dashboard, cu starea sincronizării și indicatorii Brevo esențiali
DrawerViewSertarul general al aplicației, cu acțiuni rapide și o privire de ansamblu asupra stării
SettingsViewConfigurează cheia API Brevo, preferințele de sincronizare și maparea câmpurilor
OnboardingViewÎi ghidează pe utilizatorii noi prin conectarea contului lor Brevo

Disponibilitatea viewporturilor

Nu toate viewporturile sunt disponibile în toate modurile din Stripe Dashboard:

ModViewporturi disponibile
Modul liveToate viewporturile
Modul de testToate viewporturile (folosește date de test)
SandboxToate viewporturile (dacă sandbox_install_compatible: true)

Caution

Dacă manifestul tău declară un viewport care nu există, încărcarea aplicației nu va trece de validare. Verifică întotdeauna ID-urile de viewport în această referință.

Solicită acces anticipat

Spune-ne prenumele și o adresă de e-mail sau un număr de telefon. Îți vom trimite detaliile de acces la Tajo.

detectare automată
Asistent AI

Bună! Întreabă-mă orice despre documentație.