View a markdown version of this page

Integração com o Smartsheet - Amazon Quick
Pré-requisitosConfigurar as ferramentas para desenvolvedores do SmartsheetEscopos de acesso OAuthConfigure a integração no Amazon QuickAções disponíveisGerenciar e solucionar problemas

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Integração com o Smartsheet

Use o conector de ação do Smartsheet para gerenciar planilhas, linhas, relatórios e pesquisar em seus espaços de trabalho do Smartsheet diretamente no Amazon Quick por meio de linguagem natural. Essa integração usa a API do Smartsheet. Para obter mais informações, consulte a introdução da API do Smartsheet na documentação do Smartsheet.

A configuração dessa integração envolve duas etapas. Primeiro, você configura as credenciais no Smartsheet para o método de autenticação escolhido. Em seguida, você cria a integração no Amazon Quick e a conecta à sua conta do Smartsheet. Para obter informações sobre os métodos de autenticação compatíveis com o Amazon Quick, consulteMétodos de autenticação.

Pré-requisitos

Antes de configurar a integração, certifique-se de atender aos seguintes requisitos:

Configurar as ferramentas para desenvolvedores do Smartsheet

Antes de configurar o Amazon Quick, configure as credenciais no Smartsheet. As etapas concluídas dependem do método de autenticação que você planeja usar. O Amazon Quick oferece suporte a dois métodos de autenticação para o Smartsheet. Para ter mais informações sobre esses métodos, consulte Métodos de autenticação.

Para obter mais informações sobre o Smartsheet OAuth, consulte OAuth na documentação da API do Smartsheet.

Registre-se no Developer Tools e crie um perfil de desenvolvedor

  1. Acesse a página de registro de ferramentas para desenvolvedores e registre a conta do Smartsheet que você deseja usar com seus aplicativos. Para obter mais informações, consulte Registre-se para obter ferramentas para desenvolvedores na documentação da API do Smartsheet.

  2. Depois que o Smartsheet ativar as Ferramentas do Desenvolvedor, faça login no aplicativo Smartsheet e escolha o ícone da sua Conta no canto inferior esquerdo e escolha Ferramentas do Desenvolvedor.

  3. Escolha Criar perfil de desenvolvedor e insira um nome de perfil. Para obter mais informações, consulte Criar seu perfil de desenvolvedor na documentação da API do Smartsheet.

dica

O Smartsheet recomenda usar uma conta de serviço dedicada para aplicativos OAuth em vez de uma conta pessoal.

Registre o aplicativo OAuth

  1. Nas Ferramentas para desenvolvedores do Smartsheet, escolha Criar novo aplicativo.

  2. Preencha o formulário:

    • Nome do aplicativo — Um nome para identificar seu aplicativo para os usuários.

    • Descrição do aplicativo — Uma breve descrição da integração.

    • URL do aplicativo — O URL que inicia seu aplicativo ou uma página de destino.

    • App contact/support — Informações de contato do Support.

    • URL de redirecionamento do aplicativo — https://{region}.quicksight.aws.amazon.com/sn/oauthcallback

      {region}Substitua pela sua AWS região (por exemplo,us-east-1).

  3. Escolha Salvar. O Smartsheet gera o ID do cliente do aplicativo e o segredo do aplicativo.

  4. Copie os valores de ID do cliente e segredo do cliente. Você precisa deles ao configurar a integração no Amazon Quick.

Para obter mais informações, consulte Registrar um aplicativo na documentação da API do Smartsheet.

Gere um token de acesso à API (somente autenticação de serviço)

Se você planeja usar a autenticação de serviço em vez do OAuth, gere um token de acesso à API. Você deve ter um plano Business ou Enterprise para gerar tokens. Para obter mais informações, consulte Gerar um token de acesso à API na Central de Ajuda do Smartsheet.

  1. No aplicativo Smartsheet, escolha sua Conta (imagem do perfil) na parte inferior da barra de navegação esquerda e escolha Configurações pessoais.

  2. Escolha a guia Acesso à API e escolha Gerar novo token de acesso.

  3. Nomeie o token e escolha OK. Copie o valor do token imediatamente — essa é a única vez em que ele fica visível.

Importante

Armazene seu token de acesso com segurança. Qualquer pessoa com o token pode acessar todos os dados do Smartsheet aos quais o proprietário do token tem acesso. Não comprometa tokens com sistemas de controle de versão. Para obter as melhores práticas de armazenamento de tokens, consulte Autenticação na documentação da API do Smartsheet.

Escopos de acesso OAuth

Quando você configura a autenticação do usuário (OAuth), a integração solicita os seguintes escopos de acesso do Smartsheet. Esses escopos determinam o que a integração pode fazer em nome do usuário autenticado. Se você usar a autenticação de serviço (chave de API) em vez disso, a integração usa todas as permissões do proprietário do token e os escopos não se aplicam. Para obter mais informações, consulte Escopos de acesso na documentação da API do Smartsheet.

Escopos de acesso do Smartsheet OAuth
Escopo Description
READ_SHEETS Leia todos os dados da planilha, incluindo anexos, discussões e dados de células.
WRITE_SHEETS Insira e modifique os dados da planilha, incluindo anexos, discussões e dados da célula.
nota

Os escopos de acesso não substituem as permissões de compartilhamento existentes. Por exemplo, ter o WRITE_SHEETS escopo não permite que a integração atualize uma planilha na qual o usuário tenha acesso somente no nível do visualizador. Para obter mais informações, consulte Níveis de acesso aos recursos na documentação da API do Smartsheet.

Configure a integração no Amazon Quick

Depois de concluir a configuração do Smartsheet Developer Tools, crie a integração no Amazon Quick.

  1. No console do Amazon Quick, escolha Conectores.

  2. Escolha a guia Criar para sua equipe.

  3. Encontre e escolha o Smartsheet.

  4. Insira os detalhes da integração:

    • Nome — Nome descritivo para sua integração com o Smartsheet.

    • Descrição (opcional) — Objetivo da integração.

  5. Escolha seu tipo de conexão e preencha as configurações de conexão. Para obter mais informações sobre esses métodos de autenticação, consulteMétodos de autenticação.

    1. Para autenticação de usuário (OAuth), use o ID do cliente e o segredo do cliente do registro do aplicativo Smartsheet Developer Tools. Configure os campos a seguir.

      • URL base — https://api.smartsheet.com/2.0

      • ID do cliente — ID do cliente do aplicativo do seu registro no aplicativo Smartsheet Developer Tools.

      • Segredo do cliente — Segredo do aplicativo do registro do aplicativo Smartsheet Developer Tools.

      • URL do token — https://api.smartsheet.com/2.0/token

      • URL de autenticação — https://app.smartsheet.com/b/authorize

      • URL de redirecionamento — https://{region}.quicksight.aws.amazon.com/sn/oauthcallback

    2. Para autenticação de serviço (chave de API), use o token de acesso à API nas configurações pessoais do Smartsheet. Configure os campos a seguir.

      • Chave de API — Token de acesso à API do Smartsheet gerado a partir de suas configurações pessoais.

      • URL base — https://api.smartsheet.com/2.0

      • E-mail — Endereço de e-mail associado à conta do Smartsheet que gerou o token.

  6. Escolha Criar e continuar.

  7. Escolha usuários com os quais compartilhar a integração.

  8. Escolha Próximo.

Para autenticação do usuário, acesse Conectores > o nome do seu conector do Smartsheet e escolha Entrar para concluir o fluxo de autorização do OAuth. Na janela de consentimento do Smartsheet, escolha Permitir para conceder acesso.

Importante

Com a autenticação do serviço, todas as ações são executadas usando as permissões do proprietário do token da API. Qualquer usuário do Amazon Quick com acesso a essa integração pode realizar ações em todos os recursos do Smartsheet que o proprietário do token pode acessar. Defina o escopo das permissões de token de acordo com os requisitos de segurança da sua organização.

nota

Se você usa o Smartsheet Gov, o Smartsheet Regions Europe ou o Smartsheet Regions Australia, use o URL base correspondente para o seu ambiente:

URLs de base regional do Smartsheet
Environment URL base
Smartsheet https://api.smartsheet.com/2.0
Governo do Smartsheet https://api.smartsheetgov.com/2.0
Regiões do Smartsheet na Europa https://api.smartsheet.eu/2.0
Regiões do Smartsheet na Austrália https://api.smartsheet.au/2.0

Para obter mais informações, consulte URL base na documentação da API do Smartsheet.

Ações disponíveis

Depois de configurar a integração, as ações a seguir estarão disponíveis.

Ações disponíveis do Smartsheet
Categoria Ação Description
Pesquisa Pesquisa na lista Pesquisa o texto especificado em todas as planilhas que o usuário pode acessar.
Planilhas Listar planilhas Lista todas as planilhas que podem ser acessadas pelo usuário autenticado.
Planilhas Obter planilha Obtém uma planilha e seus dados com base na ID da planilha.
Relatórios Listar relatórios Lista todos os relatórios acessíveis ao usuário.
Relatórios Exibir relatório Obtém detalhes do relatório com base na ID do relatório.

Gerenciar e solucionar problemas

Para editar, compartilhar ou excluir sua integração, consulteGerenciando integrações existentes.

Problemas de autenticação

  • Falha na autorização do OAuth — Verifique se o ID do cliente e o segredo do cliente correspondem aos valores no registro do aplicativo Smartsheet Developer Tools. Confirme se o URL de redirecionamento no Smartsheet corresponde exatamente ao URL na sua configuração do Amazon Quick. Para obter uma lista dos tipos de erro do OAuth, consulte os tipos de erro do OAuth na documentação da API do Smartsheet.

  • Ferramentas do desenvolvedor não disponíveis — Verifique se as Ferramentas do Desenvolvedor estão ativadas para sua conta do Smartsheet. As contas gratuitas não oferecem suporte às Ferramentas do Desenvolvedor. Se sua solicitação foi negada, entre em contato com o gerente de sucesso do cliente do Smartsheet.

  • Falha na autenticação da chave de API — Verifique se o token de acesso não foi revogado. Você pode gerenciar tokens em Configurações pessoais > Acesso à API no aplicativo Smartsheet. Para obter mais informações, consulte Gerar um token de acesso à API na Central de Ajuda do Smartsheet.

  • O token de acesso expirou — os tokens de acesso OAuth expiram após aproximadamente 7 dias. O Amazon Quick gerencia a atualização de tokens automaticamente. Se você encontrar erros persistentes de token, saia e entre novamente nas configurações de integração. Para obter mais informações, consulte Fazer chamadas de API na documentação da API do Smartsheet.

Mensagens de erro comuns

  • As ações retornam erros de permissão — Verifique se o usuário autenticado tem as permissões de compartilhamento necessárias nas planilhas de destino. Os escopos do OAuth não substituem os controles de acesso em nível de compartilhamento. Para obter mais informações, consulte Níveis de acesso aos recursos na documentação da API do Smartsheet.

  • Planilha não encontrada — Verifique se a ID da planilha está correta e se o usuário autenticado tem pelo menos acesso de visualizador à pasta.

  • Erros de limite de taxa da API — A API do Smartsheet impõe limites de taxa. Para obter mais informações, consulte Limitações na documentação da API do Smartsheet.