Dokumentacja uprawnień
Aplikacje Stripe Apps korzystają z systemu uprawnień, który kontroluje dostęp do zasobów API Stripe. Każde uprawnienie musisz jawnie zadeklarować w manifeście aplikacji wraz z jasnym uzasadnieniem. Użytkownicy zatwierdzają te uprawnienia podczas instalacji Twojej aplikacji.
Caution
Status: planowana. W Stripe App Marketplace nie ma jeszcze aplikacji Tajo. Identyfikatory aplikacji, adresy URL i dane dostępowe na tej stronie są przykładowymi symbolami zastępczymi, a nie działającymi endpointami.
Zarządzanie uprawnieniami
Deklarowanie uprawnień
Dodaj uprawnienia do manifestu stripe-app.json:
{ "permissions": [ { "permission": "customer_read", "purpose": "Read customer profiles to sync with Brevo contacts" }, { "permission": "customer_write", "purpose": "Update customer metadata with Brevo sync status" } ]}Przyznawanie uprawnień przez CLI
Podczas prac programistycznych możesz przyznawać uprawnienia za pomocą Stripe CLI:
# Grant a specific permissionstripe apps grant permission "customer_read" \ --purpose "Read customer profiles to sync with Brevo contacts"
# Grant multiple permissionsstripe apps grant permission "charge_read" \ --purpose "Access payment data for event tracking"
stripe apps grant permission "event_read" \ --purpose "Subscribe to real-time Stripe events"Dobre praktyki dotyczące uprawnień
- Niezbędne minimum: proś wyłącznie o uprawnienia, z których Twoja aplikacja faktycznie korzysta
- Jasne uzasadnienia: pisz uzasadnienia zrozumiałe dla osób nietechnicznych
- Uzasadnij odczyt i zapis: jeśli potrzebujesz obu, wyjaśnij dlaczego w każdym uzasadnieniu
- Regularnie przeglądaj: przy aktualizacji aplikacji usuwaj uprawnienia, które nie są już potrzebne
Tip
Prośba o nadmiarowe uprawnienia to jeden z najczęstszych powodów odrzucenia aplikacji. Proś tylko o to, czego potrzebujesz.
Uprawnienia według produktu
Core
| Zasób | Uprawnienie | Opis |
|---|---|---|
| Account | account_read | Odczyt danych i ustawień konta |
| Account | account_write | Aktualizacja ustawień konta |
| Balance | balance_read | Podgląd salda konta i transakcji |
| Customer | customer_read | Odczyt profili klientów, metadanych i metod płatności |
| Customer | customer_write | Tworzenie, aktualizowanie i usuwanie rekordów klientów |
| Event | event_read | Odczyt zdarzeń konta i subskrybowanie ich |
| File | file_read | Odczyt przesłanych plików i linków do plików |
| File | file_write | Przesyłanie plików i tworzenie linków do plików |
| Mandate | mandate_read | Odczyt upoważnień do płatności |
| Product | product_read | Odczyt katalogu produktów i cen |
| Product | product_write | Tworzenie, aktualizowanie i usuwanie produktów oraz cen |
| Token | token_read | Odczyt tokenizowanych danych płatniczych |
| Webhook Endpoint | webhook_endpoint_read | Odczyt konfiguracji endpointów webhooków |
| Webhook Endpoint | webhook_endpoint_write | Tworzenie, aktualizowanie i usuwanie endpointów webhooków |
Payments
| Zasób | Uprawnienie | Opis |
|---|---|---|
| Charge | charge_read | Odczyt obciążeń i zwrotów |
| Charge | charge_write | Tworzenie obciążeń, pobieranie płatności, realizowanie zwrotów |
| Dispute | dispute_read | Odczyt sporów płatniczych i dowodów |
| Dispute | dispute_write | Przesyłanie dowodów i odpowiadanie na spory |
| Payment Intent | payment_intent_read | Odczyt szczegółów i statusu intencji płatności |
| Payment Intent | payment_intent_write | Tworzenie, potwierdzanie i anulowanie intencji płatności |
| Payment Method | payment_method_read | Odczyt zapisanych metod płatności |
| Payment Method | payment_method_write | Przypisywanie i odłączanie metod płatności od klientów |
| Payout | payout_read | Odczyt szczegółów i harmonogramów wypłat |
| Payout | payout_write | Tworzenie i anulowanie wypłat |
| Refund | refund_read | Odczyt szczegółów zwrotów |
| Refund | refund_write | Tworzenie i aktualizowanie zwrotów |
| Setup Intent | setup_intent_read | Odczyt szczegółów intencji konfiguracji |
| Setup Intent | setup_intent_write | Tworzenie i potwierdzanie intencji konfiguracji |
Billing
| Zasób | Uprawnienie | Opis |
|---|---|---|
| Coupon | coupon_read | Odczyt kuponów rabatowych i kodów promocyjnych |
| Coupon | coupon_write | Tworzenie, aktualizowanie i usuwanie kuponów |
| Credit Note | credit_note_read | Odczyt not kredytowych |
| Credit Note | credit_note_write | Tworzenie i unieważnianie not kredytowych |
| Invoice | invoice_read | Odczyt szczegółów faktur, pozycji i statusu |
| Invoice | invoice_write | Tworzenie, aktualizowanie, finalizowanie i unieważnianie faktur |
| Invoice Item | invoice_item_read | Odczyt oczekujących pozycji faktur |
| Invoice Item | invoice_item_write | Tworzenie i usuwanie pozycji faktur |
| Plan | plan_read | Odczyt planów subskrypcji i cen |
| Plan | plan_write | Tworzenie, aktualizowanie i usuwanie planów |
| Price | price_read | Odczyt konfiguracji cen |
| Price | price_write | Tworzenie i aktualizowanie cen |
| Quote | quote_read | Odczyt ofert cenowych |
| Quote | quote_write | Tworzenie, finalizowanie i akceptowanie ofert |
| Subscription | subscription_read | Odczyt szczegółów, harmonogramów i statusu subskrypcji |
| Subscription | subscription_write | Tworzenie, aktualizowanie i anulowanie subskrypcji |
| Subscription Schedule | subscription_schedule_read | Odczyt harmonogramów subskrypcji |
| Subscription Schedule | subscription_schedule_write | Tworzenie, aktualizowanie i zwalnianie harmonogramów subskrypcji |
| Usage Record | usage_record_read | Odczyt rekordów zużycia w rozliczeniach licznikowych |
| Usage Record | usage_record_write | Tworzenie rekordów zużycia dla rozliczeń licznikowych |
Checkout
| Zasób | Uprawnienie | Opis |
|---|---|---|
| Checkout Session | checkout_session_read | Odczyt szczegółów i pozycji sesji Checkout |
| Checkout Session | checkout_session_write | Tworzenie i wygaszanie sesji Checkout |
| Payment Link | payment_link_read | Odczyt konfiguracji linków płatniczych |
| Payment Link | payment_link_write | Tworzenie i aktualizowanie linków płatniczych |
Connect
| Zasób | Uprawnienie | Opis |
|---|---|---|
| Application Fee | application_fee_read | Odczyt szczegółów opłat aplikacji |
| Connected Account | connected_account_read | Odczyt szczegółów kont połączonych |
| Connected Account | connected_account_write | Tworzenie i aktualizowanie kont połączonych |
| Transfer | transfer_read | Odczyt szczegółów transferów między kontami |
| Transfer | transfer_write | Tworzenie transferów na konta połączone |
| Top-up | topup_read | Odczyt szczegółów doładowań |
| Top-up | topup_write | Tworzenie doładowań salda Stripe |
Issuing
| Zasób | Uprawnienie | Opis |
|---|---|---|
| Issuing Card | issuing_card_read | Odczyt szczegółów wydanych kart |
| Issuing Card | issuing_card_write | Tworzenie, aktualizowanie i dezaktywowanie wydanych kart |
| Issuing Cardholder | issuing_cardholder_read | Odczyt informacji o posiadaczach kart |
| Issuing Cardholder | issuing_cardholder_write | Tworzenie i aktualizowanie posiadaczy kart |
| Issuing Transaction | issuing_transaction_read | Odczyt szczegółów transakcji kartowych |
| Issuing Authorization | issuing_authorization_read | Odczyt żądań autoryzacji |
| Issuing Authorization | issuing_authorization_write | Zatwierdzanie i odrzucanie żądań autoryzacji |
| Issuing Dispute | issuing_dispute_read | Odczyt sporów dotyczących wydanych kart |
| Issuing Dispute | issuing_dispute_write | Tworzenie i składanie sporów dotyczących wydanych kart |
Reporting
| Zasób | Uprawnienie | Opis |
|---|---|---|
| Report Run | report_run_read | Odczyt wyników uruchomionych raportów |
| Report Run | report_run_write | Uruchamianie nowych raportów |
| Report Type | report_type_read | Odczyt dostępnych typów raportów |
Tax
| Zasób | Uprawnienie | Opis |
|---|---|---|
| Tax Calculation | tax_calculation_read | Odczyt wyników obliczeń podatkowych |
| Tax Calculation | tax_calculation_write | Tworzenie obliczeń podatkowych |
| Tax Rate | tax_rate_read | Odczyt konfiguracji stawek podatkowych |
| Tax Rate | tax_rate_write | Tworzenie i aktualizowanie stawek podatkowych |
| Tax Registration | tax_registration_read | Odczyt szczegółów rejestracji podatkowych |
Terminal
| Zasób | Uprawnienie | Opis |
|---|---|---|
| Terminal Reader | terminal_reader_read | Odczyt szczegółów czytników terminali |
| Terminal Reader | terminal_reader_write | Rejestrowanie i aktualizowanie czytników terminali |
| Terminal Location | terminal_location_read | Odczyt szczegółów lokalizacji terminali |
| Terminal Location | terminal_location_write | Tworzenie i aktualizowanie lokalizacji terminali |
Secret Store
| Zasób | Uprawnienie | Opis |
|---|---|---|
| Secret | secret_read | Odczyt sekretów z Secret Store |
| Secret | secret_write | Tworzenie, aktualizowanie i usuwanie sekretów |
Zalecane uprawnienia dla integracji Tajo Brevo
Dla aplikacji integracyjnej Tajo Brevo zalecamy następujące uprawnienia:
{ "permissions": [ { "permission": "customer_read", "purpose": "Sync customer profiles and contact information to Brevo" }, { "permission": "customer_write", "purpose": "Store Brevo contact ID and sync status on customer metadata" }, { "permission": "charge_read", "purpose": "Track purchase events and revenue data for Brevo analytics" }, { "permission": "product_read", "purpose": "Sync product catalog to Brevo for personalized email campaigns" }, { "permission": "event_read", "purpose": "Listen to real-time events to trigger Brevo automation workflows" }, { "permission": "invoice_read", "purpose": "Track invoice events for transactional emails via Brevo" }, { "permission": "subscription_read", "purpose": "Monitor subscription lifecycle for Brevo retention campaigns" }, { "permission": "secret_write", "purpose": "Securely store Brevo API credentials in Stripe Secret Store" }, { "permission": "secret_read", "purpose": "Retrieve stored Brevo API credentials for data sync operations" }, { "permission": "webhook_endpoint_write", "purpose": "Register webhook endpoints for real-time event delivery to Tajo" } ]}Zakresy uprawnień
Uprawnienia mogą działać w różnych zakresach, zależnie od tego, czy Twoja aplikacja jest zainstalowana na koncie platformy, czy na koncie połączonym:
| Zakres | Opis |
|---|---|
| Account | Uprawnienia dotyczą danych konta, na którym zainstalowano aplikację |
| Connected Account | W przypadku platform Connect uprawnienia mogą obejmować także konta połączone |
Caution
Prosząc o uprawnienia do zapisu, przygotuj się na wyjaśnienie podczas weryfikacji aplikacji, w jaki sposób i kiedy Twoja aplikacja modyfikuje dane. Zbędne uprawnienia do zapisu to częsty powód odrzucenia.