Configuration commune pour les tutoriels sur les APIs REST Snowflake

Introduction

Ce tutoriel fournit des instructions pour la configuration commune requise pour tous les tutoriels des APIs REST de Snowflake disponibles dans cette documentation.

Aperçu de Snowflake REST APIs

Avant de commencer votre configuration, jetez un œil aux Snowflake REST APIs.

Les Snowflake REST APIs prennent en charge les ressources suivantes via les APIs correspondantes. Les APIs prennent en charge les opérations CREATE OR ALTER pour les ressources applicables.

Pour des informations de référence sur les APIs et leurs points de terminaison, voir Référence Snowflake REST APIs.

Astuce

Si vous préférez écrire des applications Python, vous pouvez utiliser Snowflake Python APIs pour gérer les objets Snowflake. Pour plus d’informations, voir Snowflake Python APIs : gestion des objets Snowflake avec Python.

Importation de collections d’APIs REST Snowflake

Ce tutoriel vous guide tout au long du processus d’importation des collections d’APIs REST Snowflake de Postman.

  1. Téléchargez les collections d’API du référentiel Git dans un dossier.

    ../../../_images/api-collections-git.png
  2. Ouvrez l’application Postman et créez un compte, si nécessaire.

  3. Dans Postman, ouvrez l’espace de travail souhaité.

    ../../../_images/postman-workspace.png
  4. Sélectionnez Import.

    ../../../_images/postman-import-workspace.png
  5. Sélectionnez folders.

    ../../../_images/postman-download-collections.png
  6. Dans la boîte de dialogue, sélectionnez le dossier dans lequel vous avez extrait la collection, puis sélectionnez Open.

    ../../../_images/postman-import-elements.png
  7. Vérifiez que tous les éléments sont sélectionnés et sélectionnez Import.

    Vous devriez voir les collections répertoriées dans le panneau de gauche, comme indiqué :

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

Spécifiez le jeton du porteur dans Postman

Les demandes REST nécessitent un jeton JWT dans l’en-tête de la demande pour authentifier la demande. Si vous n’avez pas de jeton JWT, voir Générer un jeton JWT.

Dans Postman, vous pouvez copier le jeton JWT dans la propriété d’en-tête bearerToken, comme indiqué.

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

Vous pouvez ensuite définir la clé x-snowflake-authorization-token-type dans KEYPAIR_JWT dans chaque en-tête de demande, comme indiqué :

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

Note

Comme mentionné dans le tutoriel sur les conditions préalables, vous devez définir une AUTHENTICATION POLICY. Si vous recevez un message d’erreur similaire à { "code": "390202", "message": "Authentication attempt rejected by the current authentication policy." }, vous pouvez exécuter la commande SQL suivante pour définir une politique :

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

Définir les variables d’environnement dans l’environnement Postman

Vous pouvez définir des variables d’environnement dans votre environnement Postman. Vous pouvez ensuite utiliser ces variables dans Postman, sous la forme {{variable_name}}.

Toutes les URLs des points de terminaison commencent par une baseURL, qui identifie votre compte Snowflake. La baseURL a la forme suivante : <account_locator>.snowflakecomputing.com, où <account_locator> est le nom de votre compte Snowflake.

Pour définir la variable baseURL, ainsi que toutes les autres variables, dans Postman, activez chaque paramètre et définissez sa valeur, comme indiqué :

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

Pour chaque valeur que vous définissez, vous devez sélectionner Save pour enregistrer la nouvelle valeur.

Quelle est la prochaine étape ?

Félicitations ! Dans ce tutoriel, vous avez appris les principes fondamentaux de la gestion des ressources de base de données, de schéma et de table Snowflake à l’aide de Snowflake REST APIs.

Résumé

En cours de route, vous avez accompli les étapes suivantes :

  • Importer des collections Snowflake REST APIs.

  • Spécifier un jeton porteur dans Postman.

  • Définir les variables d’environnement dans l’environnement Postman.

Tutoriel suivant

Vous pouvez maintenant procéder à Tutoriel 1 : Créer et gérer des bases de données, des schémas et des tables., qui vous montre comment créer et gérer des bases de données, des schémas et des tables Snowflake.