> ## 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.

# Acceso programático a la API con Postman

> Esta guía le ayudará a probar la API de ClickHouse Cloud con Postman

export const Image = ({img, alt, size}) => {
  return <Frame>
      <img src={img} alt={alt} />
    </Frame>;
};

Esta guía te ayudará a probar la API de ClickHouse Cloud con [Postman](https://www.postman.com/product/what-is-postman/).
La aplicación Postman está disponible para usarse en un navegador web o puede descargarse en un equipo de escritorio.

<div id="create-an-account">
  ### Crear una cuenta
</div>

* Puedes crear una cuenta gratuita en [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="Sitio de Postman" border width="1621" height="1011" data-path="images/cloud/manage/postman/postman1.png" />

<div id="create-a-workspace">
  ### Crear un espacio de trabajo
</div>

* Asigna un nombre a tu espacio de trabajo y establece el nivel de visibilidad.

<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="Crear un espacio de trabajo" border width="784" height="760" data-path="images/cloud/manage/postman/postman2.png" />

<div id="create-a-collection">
  ### Crear una colección
</div>

* Debajo de "Explore", en el menú superior izquierdo, haz clic en "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" />

* Se abrirá una ventana modal:

<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="Campo de URL de la API" border width="659" height="471" data-path="images/cloud/manage/postman/postman4.png" />

* Introduce la URL de la API: "[https://api.clickhouse.cloud/v1](https://api.clickhouse.cloud/v1)" y pulsa 'Enter':

* Selecciona "Postman Collection" haciendo clic en el botón "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="Colección > 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">
  ### Interactúa con la especificación de la API de ClickHouse Cloud
</div>

* La "API spec for ClickHouse Cloud" ahora aparecerá en "Collections" (navegación izquierda).

<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="Importa tu API" border width="949" height="446" data-path="images/cloud/manage/postman/postman7.png" />

* Haz clic en "API spec for ClickHouse Cloud". En el panel central, selecciona la pestaña "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="Importación completada" border width="872" height="420" data-path="images/cloud/manage/postman/postman8.png" />

<div id="set-authorization">
  ### Configurar la autorización
</div>

* Abre el menú desplegable y selecciona "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" />

* Introduce el nombre de usuario y la contraseña que recibiste al configurar tus API keys de 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="credenciales" border width="951" height="700" data-path="images/cloud/manage/postman/postman10.png" />

<div id="enable-variables">
  ### Habilitar variables
</div>

* Las [variables](https://learning.postman.com/docs/sending-requests/variables/) permiten almacenar y reutilizar valores en Postman, lo que facilita las pruebas de la API.

<div id="set-the-organization-id-and-service-id">
  #### Configura el ID de la organización y el ID del servicio
</div>

* En la "Collection", haz clic en la pestaña "Variable" del panel central (la URL base ya se habrá configurado con la importación previa de la API):
* Debajo de `baseURL`, haz clic en el campo "Add new value" y reemplázalo por tu ID de la organización y tu ID del servicio:

<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 la organización e ID del servicio" border width="1057" height="558" data-path="images/cloud/manage/postman/postman11.png" />

<div id="test-the-clickhouse-cloud-api-functionalities">
  ## Probar las funcionalidades de la API de ClickHouse Cloud
</div>

<div id="test-get-list-of-available-organizations">
  ### Pruebe "GET list of available organizations"
</div>

* En "OpenAPI spec for ClickHouse Cloud", expanda la carpeta > V1 > organizations
* Haga clic en "GET list of available organizations" y pulse el botón azul "Send" a la derecha:

<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="Pruebe la obtención de organizaciones" border width="1797" height="972" data-path="images/cloud/manage/postman/postman12.png" />

* Los resultados devueltos deberían mostrar los detalles de su organización con "status": 200. (Si recibe un "status" 400 sin información de la organización, su configuración no es correcta).

<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="Estado" border width="1797" height="972" data-path="images/cloud/manage/postman/postman13.png" />

<div id="test-get-organizational-details">
  ### Probar "GET organizational details"
</div>

* En la carpeta `organizationid`, ve a "GET organizational details":
* En el menú del panel central, en Params, se requiere un `organizationid`.

<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="Probar la obtención de los detalles de la organización" border width="1797" height="972" data-path="images/cloud/manage/postman/postman14.png" />

* Edita este valor con `orgid` entre llaves `{{orgid}}` (como ya estableciste este valor antes, aparecerá un menú con él):

<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="Enviar prueba" border width="1797" height="972" data-path="images/cloud/manage/postman/postman15.png" />

* Después de pulsar el botón "Save", pulsa el botón azul "Send" en la esquina superior derecha de la pantalla.

<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="Valor devuelto" border width="1797" height="972" data-path="images/cloud/manage/postman/postman16.png" />

* Los resultados devueltos deberían mostrar los detalles de tu organización con "status": 200. (Si recibes un "status" 400 sin información de la organización, la configuración no es correcta).

<div id="test-get-service-details">
  ### Probar "GET service details"
</div>

* Haz clic en "GET service details"
* Edita los valores de `organizationid` y `serviceid` con `{{orgid}}` y `{{serviceid}}`, respectivamente.
* Pulsa "Save" y luego el botón azul "Send", a la derecha.

<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="Lista de servicios" border width="1537" height="867" data-path="images/cloud/manage/postman/postman17.png" />

* Los resultados devueltos deberían mostrar una lista de tus servicios y sus detalles con "status": 200. (Si recibes un "status" 400 sin información de servicios, tu configuración no es correcta).
