> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-d355519d.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-d355519d/8SsI06i2_NAT3-Mi/images/cloud/manage/postman/postman1.png?fit=max&auto=format&n=8SsI06i2_NAT3-Mi&q=85&s=ebf2da1e47393b74bcfcc0b16c949f30" 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-d355519d/8SsI06i2_NAT3-Mi/images/cloud/manage/postman/postman2.png?fit=max&auto=format&n=8SsI06i2_NAT3-Mi&q=85&s=79874db8515f1889d7752f4135a0c5ed" 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-d355519d/8SsI06i2_NAT3-Mi/images/cloud/manage/postman/postman3.png?fit=max&auto=format&n=8SsI06i2_NAT3-Mi&q=85&s=fc5da4c0b33ac85dc5a2b1d10fbbb570" 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-d355519d/8SsI06i2_NAT3-Mi/images/cloud/manage/postman/postman3.png?w=280&fit=max&auto=format&n=8SsI06i2_NAT3-Mi&q=85&s=e5ab476f71bab3b708edc7cecc593d14 280w, https://mintcdn.com/private-7c7dfe99-mintlify-d355519d/8SsI06i2_NAT3-Mi/images/cloud/manage/postman/postman3.png?w=560&fit=max&auto=format&n=8SsI06i2_NAT3-Mi&q=85&s=463d43d004b7901f5c67c214bd0b982f 560w, https://mintcdn.com/private-7c7dfe99-mintlify-d355519d/8SsI06i2_NAT3-Mi/images/cloud/manage/postman/postman3.png?w=840&fit=max&auto=format&n=8SsI06i2_NAT3-Mi&q=85&s=d4f733ce02b5106228196080781ebd18 840w, https://mintcdn.com/private-7c7dfe99-mintlify-d355519d/8SsI06i2_NAT3-Mi/images/cloud/manage/postman/postman3.png?w=1100&fit=max&auto=format&n=8SsI06i2_NAT3-Mi&q=85&s=17c7ca9fcdf5871e4bd21db9a85236ff 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-d355519d/8SsI06i2_NAT3-Mi/images/cloud/manage/postman/postman3.png?w=1650&fit=max&auto=format&n=8SsI06i2_NAT3-Mi&q=85&s=50b45948f4945db1d7c0280b871fedab 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-d355519d/8SsI06i2_NAT3-Mi/images/cloud/manage/postman/postman3.png?w=2500&fit=max&auto=format&n=8SsI06i2_NAT3-Mi&q=85&s=ab6b3a0682c4d09b3ae9611d7a509744 2500w" />

* Une fenêtre modale s’ouvre :

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-d355519d/8SsI06i2_NAT3-Mi/images/cloud/manage/postman/postman4.png?fit=max&auto=format&n=8SsI06i2_NAT3-Mi&q=85&s=adbd21808af232b2660eb6cc623221f8" 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-d355519d/8SsI06i2_NAT3-Mi/images/cloud/manage/postman/postman6.png?fit=max&auto=format&n=8SsI06i2_NAT3-Mi&q=85&s=557ce3fd721af5a1dd62dc1492e10c8a" 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-d355519d/8SsI06i2_NAT3-Mi/images/cloud/manage/postman/postman6.png?w=280&fit=max&auto=format&n=8SsI06i2_NAT3-Mi&q=85&s=5718509401693764dd1e302a8150b813 280w, https://mintcdn.com/private-7c7dfe99-mintlify-d355519d/8SsI06i2_NAT3-Mi/images/cloud/manage/postman/postman6.png?w=560&fit=max&auto=format&n=8SsI06i2_NAT3-Mi&q=85&s=86be6d78b28ea1e7b0038e17137c036c 560w, https://mintcdn.com/private-7c7dfe99-mintlify-d355519d/8SsI06i2_NAT3-Mi/images/cloud/manage/postman/postman6.png?w=840&fit=max&auto=format&n=8SsI06i2_NAT3-Mi&q=85&s=68bbfeffa8c0f86ef9698f76230a014f 840w, https://mintcdn.com/private-7c7dfe99-mintlify-d355519d/8SsI06i2_NAT3-Mi/images/cloud/manage/postman/postman6.png?w=1100&fit=max&auto=format&n=8SsI06i2_NAT3-Mi&q=85&s=cf2aedc6e8a3d8e7fc655a7943a00c9c 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-d355519d/8SsI06i2_NAT3-Mi/images/cloud/manage/postman/postman6.png?w=1650&fit=max&auto=format&n=8SsI06i2_NAT3-Mi&q=85&s=21cb7bc51209e509cf43ec38efe22784 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-d355519d/8SsI06i2_NAT3-Mi/images/cloud/manage/postman/postman6.png?w=2500&fit=max&auto=format&n=8SsI06i2_NAT3-Mi&q=85&s=32bfccc98739c64952cd5493d616af8c 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-d355519d/8SsI06i2_NAT3-Mi/images/cloud/manage/postman/postman7.png?fit=max&auto=format&n=8SsI06i2_NAT3-Mi&q=85&s=cd5cf98c0d2efff1fabb05704c1ab1d0" 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-d355519d/8SsI06i2_NAT3-Mi/images/cloud/manage/postman/postman8.png?fit=max&auto=format&n=8SsI06i2_NAT3-Mi&q=85&s=e6f87208f79fde1aaf900c774830a6a6" 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-d355519d/8SsI06i2_NAT3-Mi/images/cloud/manage/postman/postman9.png?fit=max&auto=format&n=8SsI06i2_NAT3-Mi&q=85&s=2f1fdb57167972e3887b8ff893bc832b" 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-d355519d/8SsI06i2_NAT3-Mi/images/cloud/manage/postman/postman10.png?fit=max&auto=format&n=8SsI06i2_NAT3-Mi&q=85&s=9542ef5ca1fc872e0f2521e2cca88fae" 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-d355519d/8SsI06i2_NAT3-Mi/images/cloud/manage/postman/postman11.png?fit=max&auto=format&n=8SsI06i2_NAT3-Mi&q=85&s=4b392978a816e5fea6930fed0dc89f81" 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-d355519d/8SsI06i2_NAT3-Mi/images/cloud/manage/postman/postman12.png?fit=max&auto=format&n=8SsI06i2_NAT3-Mi&q=85&s=6e6f76f8703000cebd082d3e329fee26" 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-d355519d/8SsI06i2_NAT3-Mi/images/cloud/manage/postman/postman13.png?fit=max&auto=format&n=8SsI06i2_NAT3-Mi&q=85&s=ffa57a114f3e0cf32160b1d472f32d81" 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-d355519d/8SsI06i2_NAT3-Mi/images/cloud/manage/postman/postman14.png?fit=max&auto=format&n=8SsI06i2_NAT3-Mi&q=85&s=7fe5285e007fe73d96088dc2afc2f886" 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-d355519d/8SsI06i2_NAT3-Mi/images/cloud/manage/postman/postman15.png?fit=max&auto=format&n=8SsI06i2_NAT3-Mi&q=85&s=721f594f5829c7f02885ea52e543c2cd" 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-d355519d/8SsI06i2_NAT3-Mi/images/cloud/manage/postman/postman16.png?fit=max&auto=format&n=8SsI06i2_NAT3-Mi&q=85&s=82b1452e615a738f26f9c44ad11a7a4f" 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-d355519d/8SsI06i2_NAT3-Mi/images/cloud/manage/postman/postman17.png?fit=max&auto=format&n=8SsI06i2_NAT3-Mi&q=85&s=5bdde7b9a3f4867ba93954c1f492ca2d" 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.)
