> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-vortex-format.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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman1.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=8f3f7cda47c0f3ac898de4e2fd5d9248" 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman2.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=062e8c49f4bd698c7ae558c17db3f6e9" 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman3.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=52dd7913c382f5695f82b96ddd06db54" 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman3.webp?w=280&fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=95cad0f9ebefd3a779c846787b33a680 280w, https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman3.webp?w=560&fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=b36f360b8e3813cce3e4387f881ff221 560w, https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman3.webp?w=840&fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=2ac8e3e37c8c9f7ab507cd345e0b488d 840w, https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman3.webp?w=1100&fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=210a32cb766037792e07d356f180a684 1100w, https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman3.webp?w=1650&fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=04b240c713b08625e3d334df37a61775 1650w, https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman3.webp?w=2500&fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=4ae5ee8a7a8898a961a9d88482c40c76 2500w" />

* Une fenêtre modale s’ouvre :

<Image img="https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman4.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=e72a652da17e4254e0d16844d40519f0" 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman6.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=47f9f21353bc481924d8c7ef150b510c" 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman6.webp?w=280&fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=6d23976c84a141270b6b585acd7bcdba 280w, https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman6.webp?w=560&fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=490207378dbc4ca7c05a9aeade0b8187 560w, https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman6.webp?w=840&fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=18c5d07a8a32e953aadec2c263c4ffb9 840w, https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman6.webp?w=1100&fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=a1fb6d7da8ea6b3600a9aa727030c0fa 1100w, https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman6.webp?w=1650&fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=075801c79cb4beb287594df00e36f7f1 1650w, https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman6.webp?w=2500&fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=d9ea8b0fe14b1eaa42fa3fbbcceb04f1 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman7.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=65ec25c0cf1e2a2ebe433ec6b24a7286" 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman8.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=0b75da2501a9a7eba9544bbb0c49eae5" 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman9.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=86c17d0b773deebe08646fbb80e77a13" 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman10.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=91beb8e82dca2bad3d0b89516ca1b69a" 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman11.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=1371acd604d4b7ebbf14de39dad2d722" 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman12.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=70787f1f11fb6874d6e9bd77b00ee56c" 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman13.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=c32fea48083184a371b5b76868c50905" 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman14.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=f2bc64f9ab7fb1c6dec11eb2f6bff131" 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman15.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=f55000c865aefd2c971b7827e5f87b75" 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman16.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=cff855b3498fe90ecd392a143b4069d6" 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman17.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=e94dfd37404478034257b2065fba06ae" 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.)
