> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4.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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman1.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=8dec2b8e732c3532bd706b749cb3ddbe" 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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman2.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=8484a44c3a859c2176253eafe4916352" 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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman3.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=6d4aed425d88aeb47fc8d4894863059a" 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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman3.png?w=280&fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=602c6d10ea86d56aea686e721c17fc4e 280w, https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman3.png?w=560&fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=eeffd780f3cc6b3eb09140e7e0c7ddec 560w, https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman3.png?w=840&fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=52edc70a3e65fb246703dd75d232c788 840w, https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman3.png?w=1100&fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=071f8ca68d7a09c4ac3fd61eef5bd032 1100w, https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman3.png?w=1650&fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=ecc2e84bae99f8eb59bd13b9e09593ac 1650w, https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman3.png?w=2500&fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=26fca1607f60af3ebc3f1fd7c3cbd883 2500w" />

* Une fenêtre modale s’ouvre :

<Image img="https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman4.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=8785f5772f2ff830355d737e5446f281" 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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman6.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=8924a98ef43b89e2e80da2d48af5b2d6" 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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman6.png?w=280&fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=60a923c818e14533915ba570ff51dc83 280w, https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman6.png?w=560&fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=1f379bf19421ef4862029ae8c1e180f9 560w, https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman6.png?w=840&fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=272ae8b84cd4c88ebff4f8d2a54fea29 840w, https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman6.png?w=1100&fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=e372d4731887d7d4103a69cc9c950d56 1100w, https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman6.png?w=1650&fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=1b62929be42a4446b8f5b272be518c82 1650w, https://mintcdn.com/private-7c7dfe99-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman6.png?w=2500&fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=4ed0853d18ab7f0f17cadaefd7d9d849 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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman7.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=48bb0f7f5fd4e21064927373e9e3da85" 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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman8.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=27c04859b178b085ce1619cf260ef9e9" 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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman9.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=3c42e489c506c27faf88ede27843e71d" 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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman10.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=fed6667e2d0ff7e44ccf057afdb744b6" 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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman11.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=87bbac8941b2b5ed35af2227e1e886fc" 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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman12.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=b4755500eccddc9665f0ba21b8bb8fe0" 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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman13.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=e5af7e52ccfaceb93f4e6d92057f9047" 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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman14.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=823a77e43e32de30c966862207b1835d" 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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman15.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=2382d6d9a023ef1c42333029fa3b0471" 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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman16.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=32f564164d26e68e4f7f1db8050fe419" 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-locadex-parallel-t9n-main-irpovz79o3kkpgs4/O-0EO39DvOTZk4xg/images/cloud/manage/postman/postman17.png?fit=max&auto=format&n=O-0EO39DvOTZk4xg&q=85&s=071cd7570925074fe54d8dd07a521a72" 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.)
