Référence App Manifest

Le fichier stripe-app.json est la configuration centrale de votre Stripe App. Il déclare l’identité de votre app, ses permissions, vues UI, politiques de sécurité et comportement post-installation.

Exemple de Manifest complet

{
"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"
}
],
"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"
}
}

Référence du schéma

Champs de premier niveau

ChampTypeRequisDescription
idstringOuiIdentifiant unique en notation de domaine inversé
versionstringOuiChaîne de version sémantique (ex : "1.2.0")
namestringOuiNom d’affichage sur le marketplace (max 35 caractères)
iconstringOuiChemin relatif vers l’icône (PNG ou SVG 300x300)
distribution_typestringOui"public" pour le marketplace ou "private" pour usage interne
permissionsPermissionRequest[]OuiTableau de demandes de permissions
ui_extensionUIExtensionManifestNonConfiguration de l’extension UI
post_install_actionPostInstallActionNonAction après l’installation

Validation

Terminal window
# Validate manifest syntax and schema
stripe apps validate
# Check for common issues
stripe apps check

Caution

N’incluez que les domaines dont votre app a réellement besoin dans la CSP. Des entrées CSP excessives peuvent déclencher un examen supplémentaire lors de la révision.

Subscribe to updates

developer-docs

Drop your email or phone number — we'll send you what matters next.

Assistant AI

Bonjour ! Posez-moi vos questions sur la documentation.

Commencez gratuitement avec Brevo