> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-86180b7b.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-mintlify-86180b7b/kXeOHzm028vBHof0/images/cloud/manage/postman/postman1.png?fit=max&auto=format&n=kXeOHzm028vBHof0&q=85&s=b301e554bf375fdbb025f0833a20cd69" 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-mintlify-86180b7b/kXeOHzm028vBHof0/images/cloud/manage/postman/postman2.png?fit=max&auto=format&n=kXeOHzm028vBHof0&q=85&s=4ae5d42cbf3a6ffdd53052b9d3817367" 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-mintlify-86180b7b/kXeOHzm028vBHof0/images/cloud/manage/postman/postman3.png?fit=max&auto=format&n=kXeOHzm028vBHof0&q=85&s=a6367cf2d55cae74e168214d3d7bb94e" 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-86180b7b/kXeOHzm028vBHof0/images/cloud/manage/postman/postman3.png?w=280&fit=max&auto=format&n=kXeOHzm028vBHof0&q=85&s=4c5c0b97790d1a300efb64d2736e79a2 280w, https://mintcdn.com/private-7c7dfe99-mintlify-86180b7b/kXeOHzm028vBHof0/images/cloud/manage/postman/postman3.png?w=560&fit=max&auto=format&n=kXeOHzm028vBHof0&q=85&s=16f65be8d5104f4b68ebdf8f4c90b83c 560w, https://mintcdn.com/private-7c7dfe99-mintlify-86180b7b/kXeOHzm028vBHof0/images/cloud/manage/postman/postman3.png?w=840&fit=max&auto=format&n=kXeOHzm028vBHof0&q=85&s=b6b940b6d94e22991a0383cfda3ccd7c 840w, https://mintcdn.com/private-7c7dfe99-mintlify-86180b7b/kXeOHzm028vBHof0/images/cloud/manage/postman/postman3.png?w=1100&fit=max&auto=format&n=kXeOHzm028vBHof0&q=85&s=e675c1b1974fc85bd1222572eebdca1e 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-86180b7b/kXeOHzm028vBHof0/images/cloud/manage/postman/postman3.png?w=1650&fit=max&auto=format&n=kXeOHzm028vBHof0&q=85&s=1d42153b5efc674b0029b60187d73086 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-86180b7b/kXeOHzm028vBHof0/images/cloud/manage/postman/postman3.png?w=2500&fit=max&auto=format&n=kXeOHzm028vBHof0&q=85&s=33e992c41920afbcb3544a5c83576d27 2500w" />

* Se abrirá una ventana modal:

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-86180b7b/kXeOHzm028vBHof0/images/cloud/manage/postman/postman4.png?fit=max&auto=format&n=kXeOHzm028vBHof0&q=85&s=c99b406da916b723aacf98f9a927834f" 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-mintlify-86180b7b/kXeOHzm028vBHof0/images/cloud/manage/postman/postman6.png?fit=max&auto=format&n=kXeOHzm028vBHof0&q=85&s=166e1ad437f6127414fb488800608834" 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-mintlify-86180b7b/kXeOHzm028vBHof0/images/cloud/manage/postman/postman6.png?w=280&fit=max&auto=format&n=kXeOHzm028vBHof0&q=85&s=2ea9beaabc1793084d3c0be838d777a5 280w, https://mintcdn.com/private-7c7dfe99-mintlify-86180b7b/kXeOHzm028vBHof0/images/cloud/manage/postman/postman6.png?w=560&fit=max&auto=format&n=kXeOHzm028vBHof0&q=85&s=d4ebbc979c3a9fd9a453ea1073272474 560w, https://mintcdn.com/private-7c7dfe99-mintlify-86180b7b/kXeOHzm028vBHof0/images/cloud/manage/postman/postman6.png?w=840&fit=max&auto=format&n=kXeOHzm028vBHof0&q=85&s=3645f5bdd0b963d591304f860b4f1fd2 840w, https://mintcdn.com/private-7c7dfe99-mintlify-86180b7b/kXeOHzm028vBHof0/images/cloud/manage/postman/postman6.png?w=1100&fit=max&auto=format&n=kXeOHzm028vBHof0&q=85&s=c9b07f94daf6d41a88eaeeff96767559 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-86180b7b/kXeOHzm028vBHof0/images/cloud/manage/postman/postman6.png?w=1650&fit=max&auto=format&n=kXeOHzm028vBHof0&q=85&s=1534475a57dff38007f61010e723bbc0 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-86180b7b/kXeOHzm028vBHof0/images/cloud/manage/postman/postman6.png?w=2500&fit=max&auto=format&n=kXeOHzm028vBHof0&q=85&s=a79e5116fd92dfd2f7a9e393cb6398a5 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-mintlify-86180b7b/kXeOHzm028vBHof0/images/cloud/manage/postman/postman7.png?fit=max&auto=format&n=kXeOHzm028vBHof0&q=85&s=d0e79e7d87c24b28dcf1a484011c9e88" 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-mintlify-86180b7b/kXeOHzm028vBHof0/images/cloud/manage/postman/postman8.png?fit=max&auto=format&n=kXeOHzm028vBHof0&q=85&s=1ff0de91f8802016f159451514073ac0" 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-mintlify-86180b7b/kXeOHzm028vBHof0/images/cloud/manage/postman/postman9.png?fit=max&auto=format&n=kXeOHzm028vBHof0&q=85&s=60840a812bd55a893725ca09804a4338" 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-mintlify-86180b7b/kXeOHzm028vBHof0/images/cloud/manage/postman/postman10.png?fit=max&auto=format&n=kXeOHzm028vBHof0&q=85&s=810789e5d2bb4ed524c713cb84c8a3f7" 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-mintlify-86180b7b/kXeOHzm028vBHof0/images/cloud/manage/postman/postman11.png?fit=max&auto=format&n=kXeOHzm028vBHof0&q=85&s=6cd6f4f6fa20f6e47e919cf82d3dea02" 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-mintlify-86180b7b/kXeOHzm028vBHof0/images/cloud/manage/postman/postman12.png?fit=max&auto=format&n=kXeOHzm028vBHof0&q=85&s=188ab321326b82685f9aae62ea34706e" 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-mintlify-86180b7b/kXeOHzm028vBHof0/images/cloud/manage/postman/postman13.png?fit=max&auto=format&n=kXeOHzm028vBHof0&q=85&s=5853ec8b674c7ea716c6a612a42e1e59" 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-mintlify-86180b7b/kXeOHzm028vBHof0/images/cloud/manage/postman/postman14.png?fit=max&auto=format&n=kXeOHzm028vBHof0&q=85&s=f92ca2ee88e345414c2eb867f2259eb3" 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-mintlify-86180b7b/kXeOHzm028vBHof0/images/cloud/manage/postman/postman15.png?fit=max&auto=format&n=kXeOHzm028vBHof0&q=85&s=c33a88570c1fd343d5c936b79db1087e" 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-mintlify-86180b7b/kXeOHzm028vBHof0/images/cloud/manage/postman/postman16.png?fit=max&auto=format&n=kXeOHzm028vBHof0&q=85&s=49a8abdbdbd28916b532440be8d88c17" 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-mintlify-86180b7b/kXeOHzm028vBHof0/images/cloud/manage/postman/postman17.png?fit=max&auto=format&n=kXeOHzm028vBHof0&q=85&s=2f147a629de743cd263855952dd92dab" 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).
