Configuração do aplicativo (BETA)

​

Estrutura do projeto

• Todos os componentes do projeto devem estar no diretório src especificado no arquivo de configuração hsproject.json de nível superior.
• Todos os recursos e componentes do aplicativo devem estar no diretório src/app/. No diretório app/, você definirá subdiretórios para cada recurso ao qual deseja que seu aplicativo ofereça suporte:
  • Os eventos de aplicativo são configurados em app-events/.
  • Objetos de aplicativo são definidos em app-objects/.
  • Todos os recursos do cartão são definidos no cards/.
  • Os recursos da página de configurações são definidos no settings/.
  • A telemetria é configurada em telemetry/.
  • As assinaturas de webhook são definidas no diretório webhooks/.
  • As ações de fluxo de trabalho personalizadas são definidas no workflow-actions/.
• Dentro de cada subdiretório de recurso, você configurará o recurso usando um arquivo *-hsmeta.json. Você pode prefixar o nome do arquivo com algo significativo para seu aplicativo (por exemplo, my-app-hsmeta.json), desde que o arquivo termine com -hsmeta.json. Esses arquivos devem estar no nível raiz da respectiva pasta (por exemplo, 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 UIDs

​

Esquema de aplicativo

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

Campos marcados com * são obrigatórios.

​

Distribuição

• Se você planeja listar seu aplicativo no Marketplace de aplicativos da HubSpot, defina o campo distribution como "marketplace". Um exemplo de esquema de aplicativo para esta opção pode ser encontrado aqui. Se você escolher essa opção, verifique se definiu type na propriedade auth como oauth, tal como especificado na seção de autenticação abaixo.
• Se você quiser permitir que seu aplicativo seja instalado em um conjunto específico de contas permitidas, ou se quiser restringir a instalação a uma única conta por vez, defina distribution como "private". Certifique-se de definir o type dentro da propriedade auth:
  • Se você quiser instalar seu aplicativo em várias contas com base em uma lista de permissões definida nas configurações do seu projeto, defina a autenticação type como oauth. Consulte o exemplo de esquema de aplicativo para esta opção aqui.
  • Para restringir a instalação a uma única conta, seja a mesma conta usada para desenvolvimento ou outra à qual o usuário instalador tenha acesso, defina a autenticação type como static. Um exemplo de esquema de aplicativo para autenticação estática pode ser encontrado aqui.

​

Autenticação

Campos marcados com * são obrigatórios.

​

Escopos

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

​

Adicionar recursos do aplicativo

• Criar um cartão de aplicativo
• Definir eventos de aplicativo
• Criar objetos de aplicativo
• Criar um componente de configurações
• Configurar uma ação de fluxo de trabalho personalizado
• Configurar uma assinatura de webhook
• Adicionar telemetria