> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-detect-table-modification.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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman1.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=e72b02c9a09b332543342a976050a598" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman2.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=422dc9b811724600a51e1d1a06d6715a" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman3.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=a7d14257917557203e22bada43717d21" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman3.webp?w=280&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=ac2f100cbe86e984d3b66a308146f0cd 280w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman3.webp?w=560&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=542f48107296f4485736c59604593208 560w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman3.webp?w=840&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=ed138923ff712a2e09492ed31ef9edf9 840w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman3.webp?w=1100&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=f1efa5f6abd08c2e14d38cda0d4e36dc 1100w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman3.webp?w=1650&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=4b72f67d2ac0bbb25f071a3b73dbf534 1650w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman3.webp?w=2500&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=ea1bce2f113aa7d3ab29fe0c78b8e353 2500w" />

* Une fenêtre modale s’ouvre :

<Image img="https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman4.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=38d7979ba98296590d9c876c7d6bbccb" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman6.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=6bd414437c263a49d05d55300aa41607" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman6.webp?w=280&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=5149e81347497a0df7d06f060b99b822 280w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman6.webp?w=560&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=7ba9aa5b66c74bee6730f21bee456316 560w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman6.webp?w=840&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=de244832ed3f24daadd81afad9bac75e 840w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman6.webp?w=1100&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=72fa09b007806eca09e1da831735efde 1100w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman6.webp?w=1650&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=6b85cbf014b4428de85fcc4f48d2f5e6 1650w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman6.webp?w=2500&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=ba79eab2e06318ccd050a81e94b9fe7e 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman7.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=f432316604acb31ef159bd741f2da343" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman8.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=c2b4bef760535aaaf9e07c87f6e82bbf" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman9.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=46e01ea2fabaf65a6da25e766da0df9e" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman10.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=eaef923ed7870f4961a1eabbd833b847" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman11.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=1e0c8d519c256c952ee61ec294cc35b6" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman12.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=99392d42cebe9764355dfae7651ece65" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman13.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=ad80488a9cf6ba5ba56d515f1eeb3a1e" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman14.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=58f20cc3221acecc731381238beef8f5" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman15.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=d7e951fe258b988a3c81a6d8dd9c8e0e" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman16.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=b9a490e9416289f5f465372cfeb910f7" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman17.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=a5f2ad863c44e1871bcb6ae45689304a" 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.)
