Configuração comum para tutoriais das APIs REST do Snowflake

Introdução

Este tópico fornece instruções para a configuração comum necessária para todos os tutoriais das APIs REST Snowflake disponíveis nesta documentação.

Visão geral do Snowflake REST APIs

Antes de iniciar sua configuração, dê uma olhada no Snowflake REST APIs.

O Snowflake REST APIs oferece suporte aos seguintes recursos através das APIs correspondentes. As APIs oferecem suporte às operações CREATE OR ALTER para recursos aplicáveis.

Para obter informações de referência sobre as APIs e seus pontos de extremidade, consulte Referência de Snowflake REST APIs.

Dica

Se você preferir escrever aplicativos Python, é possível usar o Snowflake Python APIs para gerenciar objetos Snowflake. Para obter mais informações, consulte Snowflake Python APIs: Gerenciamento de objetos Snowflake com Python.

Importar as coleções de APIs REST Snowflake

Este tutorial explica o processo de importação das coleções APIs REST Snowflake do Postman.

  1. Baixe as coleções de API do repositório Git para uma pasta.

    ../../../_images/api-collections-git.png
  2. Abra o aplicativo Postman e crie uma conta, se necessário.

  3. No Postman, abra o espaço de trabalho desejado.

    ../../../_images/postman-workspace.png
  4. Selecione Import.

    ../../../_images/postman-import-workspace.png
  5. Selecione folders.

    ../../../_images/postman-download-collections.png
  6. Na caixa de diálogo, selecione a pasta de onde você extraiu a coleção e selecione Open.

    ../../../_images/postman-import-elements.png
  7. Verifique se todos os itens estão selecionados e selecione Import.

    Você deverá ver as coleções listadas no painel esquerdo, conforme mostrado:

    ../../../_images/postman-verify-import.png

Especifique o token do portador no Postman

As solicitações REST exigem um token JWT no cabeçalho da solicitação para autenticá-la. Se você não tiver um token JWT, consulte Como gerar um token JWT.

No Postman, é possível copiar o token JWT para a propriedade do cabeçalho bearerToken, conforme mostrado.

../../../_images/postman-bearer-token.png

É possível então definir a chave x-snowflake-authorization-token-type para KEYPAIR_JWT em cada cabeçalho de solicitação, conforme mostrado:

../../../_images/postman-set-header.png

Nota

Conforme mencionado nos pré-requisitos do tutorial, é necessário definir uma AUTHENTICATION POLICY. Se você receber uma mensagem de erro semelhante a { "code": "390202", "message": "Authentication attempt rejected by the current authentication policy." }, é possível executar o seguinte comando SQL para definir uma política:

SHOW AUTHENTICATION POLICIES; alter AUTHENTICATION POLICY <your authentication policy> set AUTHENTICATION_METHODS = ('KEYPAIR', 'PASSWORD', 'OAUTH');
Copy

Definição variáveis de ambiente no ambiente Postman

É possível definir variáveis de ambiente em seu ambiente Postman. É possível então usar essas variáveis no Postman, no formato {{variable_name}}.

Todas as URLs do ponto de extremidade começam com a baseURL, que identifica sua conta Snowflake. A baseURL tem o formato: <account_locator>.snowflakecomputing.com, onde <account_locator> é o nome da sua conta Snowflake.

Para definir a variável baseURL, bem como quaisquer outras variáveis, no Postman, habilite cada parâmetro e defina seu valor, conforme mostrado:

../../../_images/postman-env-vars.png

Para cada valor definido, é necessário selecionar Save para salvar o novo valor.

Qual é o próximo passo?

Parabéns! Neste tutorial, você aprendeu os fundamentos para gerenciar recursos de banco de dados, esquema e tabela Snowflake usando o Snowflake REST APIs.

Resumo

Ao longo do processo, você concluiu as seguintes etapas:

  • Importar coleções Snowflake REST APIs.

  • Especificar um token de portador no Postman.

  • Definir variáveis de ambiente no ambiente Postman.

Próximo tutorial

Agora você pode prosseguir para Tutorial 1: Crie e gerencie bancos de dados, esquemas e tabelas, que mostra como criar e gerenciar bancos de dados, esquemas e tabelas Snowflake.