> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-postgresql-tls-support.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Accès programmatique à l’API avec Postman

> Ce guide vous aidera à tester l’API ClickHouse Cloud à l’aide de Postman

export const Image = ({img, alt, size = "lg"}) => {
  const normalizedSize = ["sm", "md", "lg"].includes(size) ? size : "lg";
  return <div className={`ch-image-${normalizedSize}`}>
      <Frame>
        <img src={img} alt={alt} />
      </Frame>
    </div>;
};

Ce guide vous aidera à tester l’API ClickHouse Cloud à l’aide de [Postman](https://www.postman.com/product/what-is-postman/).
L’application Postman peut être utilisée dans un navigateur web ou téléchargée sur un ordinateur.

<div id="create-an-account">
  ### Créer un compte
</div>

* Des comptes gratuits sont disponibles sur [https://www.postman.com](https://www.postman.com).

<Image img="https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman1.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=2c61508912bc3427c876288254997bb3" size="md" alt="Site Postman" border width="1621" height="1011" data-path="images/cloud/manage/postman/postman1.webp" />

<div id="create-a-workspace">
  ### Créer un espace de travail
</div>

* Nommez votre espace de travail et définissez son niveau de visibilité.

<Image img="https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman2.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=89622748f40c1941e50adeed4a81a38d" size="md" alt="Créer un espace de travail" border width="784" height="760" data-path="images/cloud/manage/postman/postman2.webp" />

<div id="create-a-collection">
  ### Créer une collection
</div>

* Dans le menu en haut à gauche, sous « Explore », cliquez sur « Import » :

<Image img="https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman3.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=a273aaf7b93f95ebcef61e11409f6434" size="md" alt="Explore > Import" border data-og-width="1317" width="1317" data-og-height="647" height="647" data-path="images/cloud/manage/postman/postman3.webp" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman3.webp?w=280&fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=9f47683f18070b76cb940e34cca4d928 280w, https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman3.webp?w=560&fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=e81a2184eeaf653d7372d493f599bae4 560w, https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman3.webp?w=840&fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=f16fa40356648571f749a4b5707d187f 840w, https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman3.webp?w=1100&fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=9aa34f9b826f5b5c5c97c48afe894813 1100w, https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman3.webp?w=1650&fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=a0bae9c821215eb338109bf377983244 1650w, https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman3.webp?w=2500&fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=7f335120223de12613bcd20c19cf1afe 2500w" />

* Une fenêtre modale s’ouvre :

<Image img="https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman4.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=f5d40c45499eefccf3587e7186845b82" size="md" alt="Saisie de l’URL de l’API" border width="659" height="471" data-path="images/cloud/manage/postman/postman4.webp" />

* Saisissez l’adresse de l’API : "[https://api.clickhouse.cloud/v1](https://api.clickhouse.cloud/v1)", puis appuyez sur 'Entrée' :

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

<Image img="https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman6.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=a4669236c1c9c9a202f754f84d143276" size="md" alt="Collection > Import" border data-og-width="666" width="666" data-og-height="253" height="253" data-path="images/cloud/manage/postman/postman6.webp" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman6.webp?w=280&fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=bd61cc099cacc518f8b98f644b803d8a 280w, https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman6.webp?w=560&fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=5125e8451c84e7ca9a6bf04d08de3315 560w, https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman6.webp?w=840&fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=3430f02f162f8022fb32265d89c0adbb 840w, https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman6.webp?w=1100&fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=a33a2aef04da985b28321e76d81c0499 1100w, https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman6.webp?w=1650&fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=89b961ef83d6617643a54b1a4a6bae5b 1650w, https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman6.webp?w=2500&fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=c0fed80b77456329a1e57bf3938cdcc9 2500w" />

<div id="interface-with-the-clickhouse-cloud-api-spec">
  ### Utiliser la spécification de l’API ClickHouse Cloud
</div>

* « API spec for ClickHouse Cloud » apparaît désormais dans « Collections » (navigation de gauche).

<Image img="https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman7.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=812230ab7ce9bfadfddb8b953b82d8df" size="md" alt="Importez votre API" border width="949" height="446" data-path="images/cloud/manage/postman/postman7.webp" />

* Cliquez sur « API spec for ClickHouse Cloud ». Dans le volet central, sélectionnez l’onglet « Authorization » :

<Image img="https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman8.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=bb01720945db4154d083fd6875df2a4b" size="md" alt="Importation terminée" border width="872" height="420" data-path="images/cloud/manage/postman/postman8.webp" />

<div id="set-authorization">
  ### Configurer l’authentification
</div>

* Dans le menu déroulant, sélectionnez « Basic Auth » :

<Image img="https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman9.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=f323d24ee610a1a5e4245315ef3ebab4" size="md" alt="Basic Auth" border width="789" height="620" data-path="images/cloud/manage/postman/postman9.webp" />

* Saisissez le nom d’utilisateur et le mot de passe reçus lors de la configuration de vos clés API ClickHouse Cloud :

<Image img="https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman10.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=0eb078fcbf831047fdb7dce17abf2d59" size="md" alt="données d’authentification" border width="951" height="700" data-path="images/cloud/manage/postman/postman10.webp" />

<div id="enable-variables">
  ### Activer les variables
</div>

* Les [variables](https://learning.postman.com/docs/sending-requests/variables/) permettent de stocker et de réutiliser des valeurs dans Postman, afin de faciliter les tests d’API.

<div id="set-the-organization-id-and-service-id">
  #### Définissez l’ID de l’organisation et l’ID du service
</div>

* 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 :

<Image img="https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman11.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=1c3eca5c4968569221ccf58e517abd3a" size="md" alt="ID de l’organisation et ID du service" border width="1057" height="558" data-path="images/cloud/manage/postman/postman11.webp" />

<div id="test-the-clickhouse-cloud-api-functionalities">
  ## Tester les fonctionnalités de l’API ClickHouse Cloud
</div>

<div id="test-get-list-of-available-organizations">
  ### Tester « GET list of available organizations »
</div>

* 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 :

<Image img="https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman12.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=e49bb059e4cfd74a723921eef5806cb3" size="md" alt="Tester la récupération des organisations" border width="1797" height="972" data-path="images/cloud/manage/postman/postman12.webp" />

* 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).

<Image img="https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman13.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=f79579cbf02220bf0e616273cce74216" size="md" alt="Statut" border width="1797" height="972" data-path="images/cloud/manage/postman/postman13.webp" />

<div id="test-get-organizational-details">
  ### Tester "GET organizational details"
</div>

* Dans le dossier `organizationid`, accédez à "GET organizational details" :
* Dans le menu du panneau central, sous Params, un `organizationid` est requis.

<Image img="https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman14.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=091a3bbb2db96383507e7f72981496b5" size="md" alt="Tester la récupération des détails de l’organisation" border width="1797" height="972" data-path="images/cloud/manage/postman/postman14.webp" />

* 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) :

<Image img="https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman15.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=a5400155eba7b9ca0fdd12a27e1b9c22" size="md" alt="Soumettre le test" border width="1797" height="972" data-path="images/cloud/manage/postman/postman15.webp" />

* Après avoir cliqué sur le bouton "Save", cliquez sur le bouton bleu "Send" en haut à droite de l’écran.

<Image img="https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman16.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=5a014d30a4b683e360fc9b30c45abc73" size="md" alt="Valeur renvoyée" border width="1797" height="972" data-path="images/cloud/manage/postman/postman16.webp" />

* 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).

<div id="test-get-service-details">
  ### Tester "GET service details"
</div>

* 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.

<Image img="https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman17.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=c94295e0a6c7cd5ac8e5cde7e8b94052" size="md" alt="Liste des services" border width="1537" height="867" data-path="images/cloud/manage/postman/postman17.webp" />

* 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.)
