App-Konfiguration (BETA)

​

Projektstruktur

• Alle Projektkomponenten müssen sich in dem src-Verzeichnis befinden, das in der hsproject.json-Konfigurationsdatei der obersten Ebene angegeben ist.
• Alle App-Funktionen und -Komponenten müssen innerhalb des Verzeichnisses src/app/-gespeichert werden. In diesem app/-Verzeichnis definieren Sie Unterverzeichnisse für jede Funktion, die Ihre App unterstützen soll:
  • App-Events sind in app-events/ konfiguriert.
  • App-Objekte sind in app-objects/ definiert.
  • Alle Kartenfunktionen sind in cards/ definiert.
  • Die Funktionen der Einstellungsseite sind innerhalb von settings/ definiert.
  • Die Telemetriedaten sind in telemetry/ konfiguriert.
  • Webhook-Abonnements sind innerhalb von webhooks/ definiert.
  • Benutzerdefinierte Workflow-Aktionen sind innerhalb von workflow-actions/ definiert.
• In jedem Unterverzeichnis für Funktionen konfigurieren Sie die jeweiligen Funktionen mithilfe einer *-hsmeta.json-Datei. Sie können dem Dateinamen etwas voranstellen, das für Ihre App sinnvoll ist (z. B. my-app-hsmeta.json), solange die Datei mit -hsmeta.json endet. Diese Dateien müssen sich auf der Stammebene ihres jeweiligen Ordners befinden (z. B. 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

​

Angeben von UIDs

​

App-Schema

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"
    }
  }
}

Mit * markierte Felder sind Pflichtfelder.

​

Verteilung

• Wenn Sie Ihre App im HubSpot App Marketplace listen wollen, legen Sie das distribution-Feld auf "marketplace" fest. Ein Beispiel für ein App-Schema für diese Option finden Sie hier. Wenn Sie diese Option wählen, stellen Sie sicher, dass Sie innerhalb dem type der auth-Eigenschaft den Wert auf oauthsetzen, wie im Abschnitt Authentifizierung weiter unten beschrieben.
• Wenn Sie zulassen möchten, dass Ihre App in einer bestimmten Gruppe von Accounts der Zulassungsliste installiert werden darf, oder falls Sie die Installation jeweils auf einen einzelnen Account beschränken möchten, wählen Sie für den distribution-Wert "private". Stellen Sie sicher, dass Sie den type innerhalb der auth-Eigenschaft genauso bestimmen:
  • Wenn Sie Ihre App basierend auf einer Zulassungsliste, die Sie in Ihren Projekteinstellungen konfiguriert haben, und somit in mehreren Accounts installieren möchten, muss der type der Authentifizierung oauth lauten. Ein Beispiel für dieses App-Schema-Option finden Sie hier.
  • Um die Installation auf einen einzelnen Account zu beschränken (entweder auf den Account, den Sie für die Entwicklung verwenden, oder auf einen anderen, auf den der installierende Benutzer Zugriff hat), setzen Sie den type der Authentifizierung auf static. Ein Beispiel für ein App-Schema für statische Authentifizierung finden Sie hier.

​

Authentifizierung

Mit * markierte Felder sind Pflichtfelder.

​

Bereiche

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

​

App-Features hinzufügen

• Eine App-Karte erstellen
• App-Events definieren
• App-Objekte erstellen
• Eine Einstellungskomponente erstellen
• Eine benutzerdefinierte Workflow-Aktion einrichten
• Ein Webhook-Abonnement konfigurieren
• Telemetriedaten hinzufügen