Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs
49.6kGet Started

Accès programmatique à l’API avec Postman

View as MarkdownEdit this pageReport an issueSet up docs MCP

Ce guide vous aidera à tester l’API ClickHouse Cloud à l’aide de Postman. L’application Postman peut être utilisée dans un navigateur web ou téléchargée sur un ordinateur.

Créer un compte

Site Postman

Créer un espace de travail

  • Nommez votre espace de travail et définissez son niveau de visibilité.
Créer un espace de travail

Créer une collection

  • Dans le menu en haut à gauche, sous « Explore », cliquez sur « Import » :
Explore > Import
  • Une fenêtre modale s’ouvre :
Saisie de l’URL de l’API

  • Saisissez l’adresse de l’API : "https://api.clickhouse.cloud/v1", puis appuyez sur 'Entrée' :

  • Sélectionnez « Postman Collection » en cliquant sur le bouton « Import » :

Collection > Import

Utiliser la spécification de l’API ClickHouse Cloud

  • « API spec for ClickHouse Cloud » apparaît désormais dans « Collections » (navigation de gauche).
Importez votre API
  • Cliquez sur « API spec for ClickHouse Cloud ». Dans le volet central, sélectionnez l’onglet « Authorization » :
Importation terminée

Configurer l’authentification

  • Dans le menu déroulant, sélectionnez « Basic Auth » :
Basic Auth
  • Saisissez le nom d’utilisateur et le mot de passe reçus lors de la configuration de vos clés API ClickHouse Cloud :
données d’authentification

Activer les variables

  • Les variables permettent de stocker et de réutiliser des valeurs dans Postman, afin de faciliter les tests d’API.

Définissez l’ID de l’organisation et l’ID du service

  • Dans la « Collection », cliquez sur l’onglet « Variable » dans le panneau central (l’URL de base aura été définie lors de l’importation précédente de l’API) :
  • Sous baseURL, cliquez sur le champ vide « Add new value », puis remplacez-le par l’ID de votre organisation et l’ID de votre service :
ID de l’organisation et ID du service

Tester les fonctionnalités de l’API ClickHouse Cloud

Tester « GET list of available organizations »

  • Sous « OpenAPI spec for ClickHouse Cloud », développez le dossier > V1 > organizations
  • Cliquez sur « GET list of available organizations », puis sur le bouton bleu « Send » à droite :
Tester la récupération des organisations
  • Les résultats renvoyés doivent afficher les détails de votre organisation avec "status": 200. (Si vous obtenez un "status" 400 sans information sur l’organisation, votre configuration n’est pas correcte).
Statut

Tester "GET organizational details"

  • Dans le dossier organizationid, accédez à "GET organizational details" :
  • Dans le menu du panneau central, sous Params, un organizationid est requis.
Tester la récupération des détails de l’organisation
  • Remplacez cette valeur par orgid entre accolades, {{orgid}} (si vous avez déjà défini cette valeur auparavant, un menu apparaîtra avec cette valeur) :
Soumettre le test
  • Après avoir cliqué sur le bouton "Save", cliquez sur le bouton bleu "Send" en haut à droite de l’écran.
Valeur renvoyée
  • Les résultats renvoyés doivent afficher les détails de votre organisation avec "status": 200. (Si vous recevez un "status" 400 sans information sur l’organisation, votre configuration n’est pas correcte).

Tester "GET service details"

  • Cliquez sur "GET service details"
  • Modifiez les valeurs de organizationid et serviceid en utilisant respectivement {{orgid}} et {{serviceid}}.
  • Cliquez sur "Save", puis sur le bouton bleu "Send" à droite.
Liste des services
  • Les résultats renvoyés devraient afficher la liste de vos services et leurs détails avec "status": 200. (Si vous obtenez un "status" 400 sans aucune information sur les services, votre configuration n'est pas correcte.)
Navigation