Configuración de la aplicación (BETA)

​

Estructura del proyecto

• Todos los componentes del proyecto deben estar dentro del directorio src especificado en el archivo de configuración de nivel superior hsproject.json.
• Todas las funciones y componentes de la aplicación deben estar en el directorio src/app/. Dentro de este directorio app/, definirás subdirectorios para cada función que quieras que admita tu aplicación:
  • Los eventos de la aplicación se configuran en app-events/.
  • Los objetos de la aplicación se definen en app-objects/.
  • Todas las características de la tarjeta se definen en cards/.
  • Las funciones de la página de configuración se definen en settings/.
  • La telemetría se configura en telemetry/.
  • Las suscripciones de webhooks se definen en webhooks/.
  • Las acciones de workflow personalizadas se definen en workflow-actions/.
• Dentro de cada subdirectorio de características, configurarás la característica mediante un archivo *-hsmeta.json. Puedes anteponer al nombre del archivo algo significativo para tu aplicación (por ejemplo, my-app-hsmeta.json), siempre que el archivo termine en -hsmeta.json. Estos archivos deben estar en el nivel base de sus respectivas carpetas (por ejemplo, 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

​

Especificar UID

​

Esquema de la aplicación

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

Los campos marcados con * son obligatorios.

​

Distribución

• Si piensas publicar tu aplicación en el mercado de aplicaciones de HubSpot, establece el campo distribution en "marketplace". Puedes encontrar un esquema de aplicación de ejemplo para esta opción aquí. Si eliges esta opción, asegúrate de establecer el type dentro de la propiedad auth en oauth, tal y como se detalla en la sección de autenticación más adelante.
• Si quieres permitir que tu aplicación se instale en un conjunto específico de cuentas permitidas, o si quieres restringir la instalación a una sola cuenta cada vez, configura distribution en "private". Asegúrate de configurar el type dentro de la propiedad auth en consecuencia:
  • Si quieres instalar tu aplicación en varias cuentas basándote en una lista de permisos que configures en los ajustes de tu proyecto, establece la autenticación type en oauth. Consulta el esquema de aplicación de ejemplo para esta opción.
  • Para restringir la instalación a una sola cuenta, ya sea la misma que utilizas para el desarrollo u otra cuenta a la que tenga acceso el usuario instalador, establece la autenticación type en static. Puedes encontrar un esquema de aplicación de ejemplo para la autenticación estática.

​

Autenticación

Los campos marcados con * son obligatorios.

​

Permisos

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

​

Agregando funciones a la aplicación

• Crear una tarjeta de aplicación
• Definir eventos de aplicación
• Crear objetos de aplicación
• Crear un componente de configuración
• Configurar una acción de workflow personalizada
• Configurar una suscripción de webhook
• Agregar telemetría