> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-560f2a74.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}) => {
  return <Frame>
      <img src={img} alt={alt} />
    </Frame>;
};

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-mintlify-560f2a74/pBA9c4pPdB-fituR/images/cloud/manage/postman/postman1.png?fit=max&auto=format&n=pBA9c4pPdB-fituR&q=85&s=d89ee5c83c3d78f77441022b3637ca84" size="md" alt="Site Postman" border width="1621" height="1011" data-path="images/cloud/manage/postman/postman1.png" />

<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-mintlify-560f2a74/pBA9c4pPdB-fituR/images/cloud/manage/postman/postman2.png?fit=max&auto=format&n=pBA9c4pPdB-fituR&q=85&s=a498ef36abd7631e3a76ca4dd20ac6c1" size="md" alt="Créer un espace de travail" border width="784" height="760" data-path="images/cloud/manage/postman/postman2.png" />

<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-mintlify-560f2a74/pBA9c4pPdB-fituR/images/cloud/manage/postman/postman3.png?fit=max&auto=format&n=pBA9c4pPdB-fituR&q=85&s=35869d93a76ccc745cca185a6b992b43" 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.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/private-7c7dfe99-mintlify-560f2a74/pBA9c4pPdB-fituR/images/cloud/manage/postman/postman3.png?w=280&fit=max&auto=format&n=pBA9c4pPdB-fituR&q=85&s=e403009e200d060b09ca8e5dd702d891 280w, https://mintcdn.com/private-7c7dfe99-mintlify-560f2a74/pBA9c4pPdB-fituR/images/cloud/manage/postman/postman3.png?w=560&fit=max&auto=format&n=pBA9c4pPdB-fituR&q=85&s=5777f0ed0a7582a27303ba1fe8c560ef 560w, https://mintcdn.com/private-7c7dfe99-mintlify-560f2a74/pBA9c4pPdB-fituR/images/cloud/manage/postman/postman3.png?w=840&fit=max&auto=format&n=pBA9c4pPdB-fituR&q=85&s=c438979583ccb81ac2c621c34849af62 840w, https://mintcdn.com/private-7c7dfe99-mintlify-560f2a74/pBA9c4pPdB-fituR/images/cloud/manage/postman/postman3.png?w=1100&fit=max&auto=format&n=pBA9c4pPdB-fituR&q=85&s=4b53cafc835c1c797d4c6f035e14488e 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-560f2a74/pBA9c4pPdB-fituR/images/cloud/manage/postman/postman3.png?w=1650&fit=max&auto=format&n=pBA9c4pPdB-fituR&q=85&s=cfef789bd7852c8e24cda6704c063f13 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-560f2a74/pBA9c4pPdB-fituR/images/cloud/manage/postman/postman3.png?w=2500&fit=max&auto=format&n=pBA9c4pPdB-fituR&q=85&s=06e7d16b757a6ed454c4b11de5067729 2500w" />

* Une fenêtre modale s’ouvre :

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-560f2a74/pBA9c4pPdB-fituR/images/cloud/manage/postman/postman4.png?fit=max&auto=format&n=pBA9c4pPdB-fituR&q=85&s=a9ee13d6cce89e7a0f9240f23e693baf" size="md" alt="Saisie de l’URL de l’API" border width="659" height="471" data-path="images/cloud/manage/postman/postman4.png" />

* 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-mintlify-560f2a74/pBA9c4pPdB-fituR/images/cloud/manage/postman/postman6.png?fit=max&auto=format&n=pBA9c4pPdB-fituR&q=85&s=7b855c70c3b6973913f87274586f2f9b" 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.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/private-7c7dfe99-mintlify-560f2a74/pBA9c4pPdB-fituR/images/cloud/manage/postman/postman6.png?w=280&fit=max&auto=format&n=pBA9c4pPdB-fituR&q=85&s=a7ca1a356f31c5a2b824354539609da4 280w, https://mintcdn.com/private-7c7dfe99-mintlify-560f2a74/pBA9c4pPdB-fituR/images/cloud/manage/postman/postman6.png?w=560&fit=max&auto=format&n=pBA9c4pPdB-fituR&q=85&s=064a2d2998584e31adb4878da8fa1124 560w, https://mintcdn.com/private-7c7dfe99-mintlify-560f2a74/pBA9c4pPdB-fituR/images/cloud/manage/postman/postman6.png?w=840&fit=max&auto=format&n=pBA9c4pPdB-fituR&q=85&s=9c53334f12a1f0ceb832c961101e0d2a 840w, https://mintcdn.com/private-7c7dfe99-mintlify-560f2a74/pBA9c4pPdB-fituR/images/cloud/manage/postman/postman6.png?w=1100&fit=max&auto=format&n=pBA9c4pPdB-fituR&q=85&s=4334659331d17f445897bfb508b16701 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-560f2a74/pBA9c4pPdB-fituR/images/cloud/manage/postman/postman6.png?w=1650&fit=max&auto=format&n=pBA9c4pPdB-fituR&q=85&s=bce9c57cfa2f368f7e9b6a362f2bdc9a 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-560f2a74/pBA9c4pPdB-fituR/images/cloud/manage/postman/postman6.png?w=2500&fit=max&auto=format&n=pBA9c4pPdB-fituR&q=85&s=b9817ff40e272cc8af469aed2196e91e 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-mintlify-560f2a74/pBA9c4pPdB-fituR/images/cloud/manage/postman/postman7.png?fit=max&auto=format&n=pBA9c4pPdB-fituR&q=85&s=9961ef5c64fabe2102634c83ce512a2e" size="md" alt="Importez votre API" border width="949" height="446" data-path="images/cloud/manage/postman/postman7.png" />

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

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-560f2a74/pBA9c4pPdB-fituR/images/cloud/manage/postman/postman8.png?fit=max&auto=format&n=pBA9c4pPdB-fituR&q=85&s=6d7770d43be7e682cb9552f2b44e5c0f" size="md" alt="Importation terminée" border width="872" height="420" data-path="images/cloud/manage/postman/postman8.png" />

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

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

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-560f2a74/pBA9c4pPdB-fituR/images/cloud/manage/postman/postman9.png?fit=max&auto=format&n=pBA9c4pPdB-fituR&q=85&s=0c5b5b4dd9c33ce0549bd9e270e84a60" size="md" alt="Basic Auth" border width="789" height="620" data-path="images/cloud/manage/postman/postman9.png" />

* 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-mintlify-560f2a74/pBA9c4pPdB-fituR/images/cloud/manage/postman/postman10.png?fit=max&auto=format&n=pBA9c4pPdB-fituR&q=85&s=16aa97ec7f8daac9ba8d16a17c4674f4" size="md" alt="données d’authentification" border width="951" height="700" data-path="images/cloud/manage/postman/postman10.png" />

<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-mintlify-560f2a74/pBA9c4pPdB-fituR/images/cloud/manage/postman/postman11.png?fit=max&auto=format&n=pBA9c4pPdB-fituR&q=85&s=e3e5fe1a9fddaf22259d4ad176025c16" size="md" alt="ID de l’organisation et ID du service" border width="1057" height="558" data-path="images/cloud/manage/postman/postman11.png" />

<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-mintlify-560f2a74/pBA9c4pPdB-fituR/images/cloud/manage/postman/postman12.png?fit=max&auto=format&n=pBA9c4pPdB-fituR&q=85&s=4ce35a66d69d6cdeee350392c76aaaca" size="md" alt="Tester la récupération des organisations" border width="1797" height="972" data-path="images/cloud/manage/postman/postman12.png" />

* 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-mintlify-560f2a74/pBA9c4pPdB-fituR/images/cloud/manage/postman/postman13.png?fit=max&auto=format&n=pBA9c4pPdB-fituR&q=85&s=fce6b95976c90ad2f3fe1923ac928f71" size="md" alt="Statut" border width="1797" height="972" data-path="images/cloud/manage/postman/postman13.png" />

<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-mintlify-560f2a74/pBA9c4pPdB-fituR/images/cloud/manage/postman/postman14.png?fit=max&auto=format&n=pBA9c4pPdB-fituR&q=85&s=d7e640f808dc3f516f113d8898900dbf" 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.png" />

* 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-mintlify-560f2a74/pBA9c4pPdB-fituR/images/cloud/manage/postman/postman15.png?fit=max&auto=format&n=pBA9c4pPdB-fituR&q=85&s=2deaa5997e3bff3eac85cd1f25f989bd" size="md" alt="Soumettre le test" border width="1797" height="972" data-path="images/cloud/manage/postman/postman15.png" />

* 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-mintlify-560f2a74/pBA9c4pPdB-fituR/images/cloud/manage/postman/postman16.png?fit=max&auto=format&n=pBA9c4pPdB-fituR&q=85&s=55b04f6dcf1044337c60c49fb05fac53" size="md" alt="Valeur renvoyée" border width="1797" height="972" data-path="images/cloud/manage/postman/postman16.png" />

* 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-mintlify-560f2a74/pBA9c4pPdB-fituR/images/cloud/manage/postman/postman17.png?fit=max&auto=format&n=pBA9c4pPdB-fituR&q=85&s=707bc962722c30629dbc70017b6e1580" size="md" alt="Liste des services" border width="1537" height="867" data-path="images/cloud/manage/postman/postman17.png" />

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