Artigo

5 etapas para começar a usar a API do Smartsheet

by Taylor Krusen

As equipes de TI inovadoras que usam a API do Smartsheet têm acesso aos benefícios logo que a integração é ativada. A API é uma ferramenta avançada para desenvolvedores que ajuda a garantir a combinação do gerenciamento seguro de dados com a automação por webhooks e a capacidade de colocação em escala do Smartsheet para adoção em toda a empresa.  

Você quer criar uma integração usando a API do Smartsheet, mas não sabe por onde começar? Siga as cinco etapas descritas abaixo:

1. Confira os recursos para desenvolvedores

No portal do Smartsheet para desenvolvedores, você encontra todos os recursos necessários, como a documentação da API, informações sobre os SDKs do Smartsheet, perguntas específicas sobre a API e respostas enviadas pela nossa comunidade de usuários e muito mais.

Sabemos que a vontade de começar logo a criar a integração é grande, mas é importante conferir os recursos com calma, pois depois você terá menos trabalho. 

Onde encontrar a documentação da API

Depois de assistir ao vídeo, acesse a página de documentação da API. Se você quer criar uma integração que chame diretamente a API do Smartsheet ou que use um SDK do Smartsheet, consulte os documentos da API, pois eles têm muitas informações úteis. Primeiro, leia estas seções:

  • Visão geral: um contexto geral para trabalhar com a API do Smartsheet

  • Primeiros passos: informações necessárias para criar os componentes básicos da integração

  • Solução de problemas: um plano para resolver os problemas se você não conseguir avançar em alguma etapa

SDKs do Smartsheet

Com os kits de desenvolvimento de software (SDKs) do Smartsheet, você pode acessar a API do Smartsheet usando a linguagem de programação de sua escolha sem ter que escrever todo o código do zero. Além das formas pré-prontas, cada SDK inclui uma lógica de repetição (para erros de limite de taxa) e sistemas de registro.

Todos os SDKs (C#, Java, Node, Python, Ruby) têm documentos e planilhas com exemplos de leitura/gravação disponíveis para referência.

2. Cadastre-se como desenvolvedor (opcional)

Depois de conferir os recursos do Smartsheet para desenvolvedores, você poderá criar os componentes básicos da integração.

Crie uma conta de desenvolvedor

Para criar um aplicativo de terceiros ou uma conta sandbox do Smartsheet e usá-la para fins de desenvolvimento e teste (sem afetar os dados da sua conta de produção do Smartsheet), siga o processo de cadastro como desenvolvedor.

3. Gere um token de acesso

Captura de tela para ter acesso ao Smartsheet

Depois, para autenticar solicitações de API pelo acesso direto de API, você precisará de um token de acesso de API pertencente à conta do Smartsheet que deseja acessar. É possível gerar os tokens de acesso pela interface do usuário do Smartsheet. Basta fazer login na sua conta do Smartsheet e seguir as instruções aqui.

Se você quer criar um aplicativo de terceiros que implementará o fluxo de OAuth2 para recuperar um token de acesso que pode ser usado para acessar os dados do Smartsheet em nome de um usuário final, não precisa gerar manualmente um token de acesso, conforme descrito acima. Consulte os documentos da API para saber mais sobre o desenvolvimento de aplicativos de terceiros.

Caso você queira criar um aplicativo de terceiros destinado a outros usuários, precisará implementar um fluxo de OAuth2 para recuperar um token de acesso. A geração automática (em vez de manual) de um token de acesso garante que o usuário tenha seu próprio token para acessar seus dados do Smartsheet. Recomendamos consultar a seção de documentos da API sobre o desenvolvimento de aplicativos de terceiros. Outra referência disponível é um tutorial sobre como criar um fluxo de OAuth do Smartsheet em Node.js.

4. Comece a criar a integração

O processo de criação da integração varia de acordo com as suas escolhas: você pode optar ou não por usar um SDK. Confira abaixo os detalhes das duas abordagens:

Com o uso de um SDK

Para usar um SDK como base para a integração, siga as instruções de instalação do kit de sua escolha. Depois, leia a documentação da API para ver exemplos de código e siga estas etapas:

  1. No painel de exemplos de código no lado direito da página, selecione a guia do idioma de seu interesse.

  2. Confira os exemplos de leia-me e leitura/gravação do respectivo SDK. Todos os links estão disponíveis no portal do Smartsheet para desenvolvedores.

  3. Abra a seção Referência de API para ver um exemplo de código que mostra como executar a operação usando o SDK.

Sem o uso de um SDK

Embora o uso de um SDK seja vantajoso, não é obrigatório. Se você optar por não usar um SDK e preferir criar uma integração personalizada do zero, use a documentação da API como principal recurso. Caso não consiga avançar em alguma etapa, faça perguntas no StackOverflow usando a tag smartsheet-api. Sua pergunta pode ajudar outras pessoas no futuro.

5. Peça ajuda à equipe de suporte do Smartsheet

Talvez você encontre um problema na API ou no SDK que não consegue resolver usando nossas orientações de solução de problemas de API ou tenha uma dúvida que não foi resolvida pela documentação da API. Publique o problema ou a pergunta no StackOverflow. Nós e milhares de desenvolvedores em todo o mundo poderemos ajudar você.

Tem comentários sobre a API ou quer sugerir novos recursos? Entre em contato conosco em DevRel@smartsheet.com.

Conheça mais recursos

Aprender a usar uma nova API leva um tempo, mas os recursos e processos certos podem fazer toda a diferença.

Recomendamos acessar o portal do Smartsheet para desenvolvedores, em que você tem acesso a recursos e orientações que podem ajudar a se familiarizar com a API do Smartsheet e a implantar a sua solução com confiança.  

Inscreva-se no Boletim informativo de TI do Smartsheet para receber dicas, estratégias e ideias focadas em ajudar os profissionais de TI a aumentar seu impacto nos negócios.