On this page

Reference manifestu aplikace

Soubor manifestu stripe-app.json je centrální konfigurací pro vaši Stripe App. Deklaruje identitu vaší aplikace, oprávnění, UI pohledy, bezpečnostní politiky a chování po instalaci.

Úplný příklad manifestu

{
  "id": "com.tajo.brevo-integration",
  "version": "1.2.0",
  "name": "Tajo for Brevo",
  "icon": "./assets/icon.png",
  "distribution_type": "public",
  "sandbox_install_compatible": true,
  "stripe_api_access_type": "oauth",
  "allowed_redirect_uris": [
    "https://tajo.io/stripe/callback",
    "https://tajo.io/stripe/oauth/complete"
  ],
  "permissions": [
    {
      "permission": "customer_read",
      "purpose": "Read customer profiles to sync with Brevo contacts"
    },
    {
      "permission": "customer_write",
      "purpose": "Update customer metadata with Brevo sync status"
    }
  ],
  "ui_extension": {
    "views": [
      {
        "viewport": "stripe.dashboard.customer.detail",
        "component": "CustomerDetailView"
      },
      {
        "viewport": "stripe.dashboard.home.overview",
        "component": "OverviewView"
      }
    ],
    "content_security_policy": {
      "connect-src": [
        "https://api.tajo.io",
        "https://api.brevo.com"
      ],
      "purpose": "Connect to Tajo API for data sync and Brevo API for contact management"
    }
  },
  "post_install_action": {
    "type": "onboarding"
  },
  "constants": {
    "API_BASE_URL": "https://api.tajo.io/v1",
    "SYNC_INTERVAL_SECONDS": "300"
  }
}

Schéma reference

Pole nejvyšší úrovně

Pole	Typ	Povinné	Popis
`id`	string	Ano	Unikátní identifikátor aplikace v notaci zpětné domény
`version`	string	Ano	Řetězec sémantické verze (např. `"1.2.0"`)
`name`	string	Ano	Zobrazovaný název na marketplace (max 35 znaků)
`icon`	string	Ano	Relativní cesta k souboru ikony aplikace (300x300 PNG nebo SVG)
`distribution_type`	string	Ano	`"public"` pro marketplace nebo `"private"` pro interní použití
`sandbox_install_compatible`	boolean	Ne	Zda aplikaci lze nainstalovat v sandbox/testovacím režimu
`stripe_api_access_type`	string	Ne	Metoda přístupu k API: `"oauth"` nebo `"api_key"`
`allowed_redirect_uris`	string[]	Ne	Povolené OAuth redirect URI pro instalační tok
`permissions`	PermissionRequest[]	Ano	Pole požadavků na oprávnění
`ui_extension`	UIExtensionManifest	Ne	Konfigurace UI rozšíření
`post_install_action`	PostInstallAction	Ne	Akce po instalaci aplikace
`constants`	object	Ne	Páry klíč-hodnota přístupné v aplikaci za běhu

distribution_type

Řídí, kdo může vaši aplikaci nainstalovat:

Hodnota	Popis
`"public"`	K dispozici na Stripe App Marketplace všem uživatelům
`"private"`	Instalovatelné pouze vaším vlastním účtem Stripe

stripe_api_access_type

Určuje, jak se vaše aplikace autentizuje s Stripe API:

Hodnota	Popis
`"oauth"`	Používá OAuth 2.0 tok pro autentizaci (doporučeno pro veřejné aplikace)
`"api_key"`	Používá omezené API klíče (vhodné pro soukromé aplikace)

Typy PostInstallAction

Typ	Chování
`"onboarding"`	Otevře onboardingový pohled aplikace v Dashboard
`"settings"`	Otevře pohled nastavení aplikace v Dashboard
`"external"`	Přesměruje uživatele na externí URL (vyžaduje pole `url`)

Konstanty

Definujte statické páry klíč-hodnota přístupné za běhu:

{
  "constants": {
    "API_BASE_URL": "https://api.tajo.io/v1",
    "SYNC_INTERVAL_SECONDS": "300",
    "MAX_BATCH_SIZE": "100"
  }
}

Všechny hodnoty musí být řetězce
Konstanty jsou vloženy do aplikace v době sestavení
Nikdy neukládejte tajemství nebo API klíče jako konstanty, používejte Secret Store API

Validace

Ověřte manifest před nahráním:

# Ověřte syntaxi a schéma manifestu
stripe apps validate

# Zkontrolujte běžné problémy
stripe apps check