Configuration de l'application (BÊTA)

​

Structure du projet

• Tous les composants du projet doivent se trouver dans le répertoire src spécifié dans le fichier de configuration hsproject.json de premier niveau.
• Toutes les fonctionnalités et tous les composants de l’application doivent se trouver dans le répertoire src/app/. Dans ce répertoire app/, vous définirez des sous-répertoires pour chaque fonctionnalité que vous souhaitez que votre application prenne en charge :
  • Les événements d’application sont configurés dans app-events/.
  • Les objets d’application sont définis dans app-objects/.
  • Toutes les caractéristiques de la carte sont définies dans cards/.
  • Les fonctionnalités de la page Paramètres sont définies dans settings/.
  • La télémétrie est configurée dans telemetry/.
  • Les abonnements Webhook sont définis dans webhooks/.
  • Les actions de workflow personnalisées sont définies dans workflow-actions/.
• Dans chaque sous-répertoire d’entités, vous configurerez l’entité à l’aide d’un fichier *-hsmeta.json. Vous pouvez préfixer le nom du fichier avec un élément significatif pour votre application (par exemple, my-app-hsmeta.json), tant que le fichier se termine par -hsmeta.json. Ces fichiers doivent se trouver à la racine de leur dossier respectif (par exemple, app/my-app-hsmeta.json, cards/my-card-hsmeta.json).

my-project-folder/
└── hsproject.json
└── src
    └── app/
        └── app-hsmeta.json/
        └── app-events/
            └── my-event-type-hsmeta.json
        └── cards/
            └── MyCard.jsx
            └── my-app-card-hsmeta.json
            └── package.json
        └── settings/
            └── Settings.tsx
            └── settings-hsmeta.json
            └── package.json
        └── telemetry/
            └── telemetry-hsmeta.json
        └── webhooks/
            └── webhooks-hsmeta.json
        └── workflow-actions/
            └── custom-action-hsmeta.json

​

Spécification des UID

​

Schéma de l’application

my-project-folder/
└── src
    └── app/
        └── app-hsmeta.json/

{
  "uid": "new_developer_platform_app",
  "type": "app",
  "config": {
    "description": "An example to demonstrate how to build an app with developer projects.",
    "name": "my first app",
    "distribution": "marketplace",
    "auth": {
      "type": "oauth",
      "redirectUrls": ["http://localhost:3000/oauth-callback"],
      "requiredScopes": [
        "crm.objects.contacts.read",
        "crm.objects.contacts.write"
      ],
      "optionalScopes": [],
      "conditionallyRequiredScopes": []
    },
    "permittedUrls": {
      "fetch": ["https://api.hubapi.com"],
      "iframe": [],
      "img": []
    },
    "support": {
      "supportEmail": "support@example.com",
      "documentationUrl": "https://example.com/docs",
      "supportUrl": "https://example.com/support",
      "supportPhone": "+18005555555"
    }
  }
}

Les champs marqués par sont * obligatoires.

​

Distribution

• Si vous prévoyez de lister votre application sur le marketplace des applications de HubSpot, définissez le champ distribution sur "marketplace". Un exemple de schéma d’application pour cette option se trouve ici. Si vous choisissez cette option, assurez-vous de définir dans type avec la propriété auth sur oauth, comme indiqué dans la section Authentification ci-dessous.
• Si vous souhaitez autoriser l’installation de votre application sur un ensemble spécifique de comptes ajoutés à la liste d’autorisation ou si vous souhaitez limiter l’installation à un seul compte à la fois, définissez distribution sur "private". Veillez à définir le type dans la propriété auth en conséquence :
  • Si vous souhaitez installer votre application dans plusieurs comptes sur la base d’une liste d’inclusion que vous configurez dans les paramètres de votre projet, définissez l’authentification type sur oauth. Consultez l’exemple de schéma d’application pour cette option ici.
  • Pour limiter l’installation à un seul compte, soit le même que celui que vous utilisez pour le développement, soit un autre compte auquel l’utilisateur installateur a accès, définissez l’authentification type sur static. Un exemple de schéma d’application pour l’authentification statique est disponible ici.

​

Authentification

Les champs marqués par sont * obligatoires.

​

Périmètres d’accès

"auth": {
      "type" : "oauth",
      "redirectUrls": ["http://localhost:3000/oauth-callback"],
      "requiredScopes": [
        "crm.objects.contacts.read",
        "crm.objects.contacts.write"
      ],
      "optionalScopes": [],
      "conditionallyRequiredScopes": []
    },

​

Ajout de fonctionnalités de l’application

• Créer une carte d’application
• Définir des événements d’application
• Créer des objets d’application
• Créer un composant de paramètres
• Configurer une action de workflow personnalisée
• Configurer un abonnement au webhook
• Ajouter des données de télémétrie