> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-0c00d93d.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-0c00d93d/pZecIZCRexa8jqym/images/cloud/manage/postman/postman1.png?fit=max&auto=format&n=pZecIZCRexa8jqym&q=85&s=2ca9b1d0ce07cd01b3d2a37d702b5941" 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-0c00d93d/pZecIZCRexa8jqym/images/cloud/manage/postman/postman2.png?fit=max&auto=format&n=pZecIZCRexa8jqym&q=85&s=d3efa9084e76f7eb2cae38dc528e5a72" 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-0c00d93d/pZecIZCRexa8jqym/images/cloud/manage/postman/postman3.png?fit=max&auto=format&n=pZecIZCRexa8jqym&q=85&s=f92f3736d67bd82e78ddb362f67c8cc4" 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-0c00d93d/pZecIZCRexa8jqym/images/cloud/manage/postman/postman3.png?w=280&fit=max&auto=format&n=pZecIZCRexa8jqym&q=85&s=fb2ea508745cebf268eadbd2ed82a7de 280w, https://mintcdn.com/private-7c7dfe99-mintlify-0c00d93d/pZecIZCRexa8jqym/images/cloud/manage/postman/postman3.png?w=560&fit=max&auto=format&n=pZecIZCRexa8jqym&q=85&s=69bcc17ff80d615dcd5c7c808da1ebae 560w, https://mintcdn.com/private-7c7dfe99-mintlify-0c00d93d/pZecIZCRexa8jqym/images/cloud/manage/postman/postman3.png?w=840&fit=max&auto=format&n=pZecIZCRexa8jqym&q=85&s=360b374c4a307111667c97573686e172 840w, https://mintcdn.com/private-7c7dfe99-mintlify-0c00d93d/pZecIZCRexa8jqym/images/cloud/manage/postman/postman3.png?w=1100&fit=max&auto=format&n=pZecIZCRexa8jqym&q=85&s=0c378f25c75976b94bf2f7963435da3d 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-0c00d93d/pZecIZCRexa8jqym/images/cloud/manage/postman/postman3.png?w=1650&fit=max&auto=format&n=pZecIZCRexa8jqym&q=85&s=822254b888010feb7eb1b1dd30fb02c9 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-0c00d93d/pZecIZCRexa8jqym/images/cloud/manage/postman/postman3.png?w=2500&fit=max&auto=format&n=pZecIZCRexa8jqym&q=85&s=55c7e476cd1afd79a9ffb5eb669ef6a0 2500w" />

* Se abrirá una ventana modal:

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-0c00d93d/pZecIZCRexa8jqym/images/cloud/manage/postman/postman4.png?fit=max&auto=format&n=pZecIZCRexa8jqym&q=85&s=b636137cdf9c8d2a6e4047f1bc7ad825" 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-0c00d93d/pZecIZCRexa8jqym/images/cloud/manage/postman/postman6.png?fit=max&auto=format&n=pZecIZCRexa8jqym&q=85&s=afa9eda052408eac03a4a218c72f51b0" 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-0c00d93d/pZecIZCRexa8jqym/images/cloud/manage/postman/postman6.png?w=280&fit=max&auto=format&n=pZecIZCRexa8jqym&q=85&s=e98c898f2697d34c11eb7d0667f50e41 280w, https://mintcdn.com/private-7c7dfe99-mintlify-0c00d93d/pZecIZCRexa8jqym/images/cloud/manage/postman/postman6.png?w=560&fit=max&auto=format&n=pZecIZCRexa8jqym&q=85&s=09739c378c8dbac0806030d5a01457db 560w, https://mintcdn.com/private-7c7dfe99-mintlify-0c00d93d/pZecIZCRexa8jqym/images/cloud/manage/postman/postman6.png?w=840&fit=max&auto=format&n=pZecIZCRexa8jqym&q=85&s=33201269df41d72588f185fb9c271d8e 840w, https://mintcdn.com/private-7c7dfe99-mintlify-0c00d93d/pZecIZCRexa8jqym/images/cloud/manage/postman/postman6.png?w=1100&fit=max&auto=format&n=pZecIZCRexa8jqym&q=85&s=829c5363817e40529231ab87272998b9 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-0c00d93d/pZecIZCRexa8jqym/images/cloud/manage/postman/postman6.png?w=1650&fit=max&auto=format&n=pZecIZCRexa8jqym&q=85&s=5197e4e68ef84341856b7d5c1c02e962 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-0c00d93d/pZecIZCRexa8jqym/images/cloud/manage/postman/postman6.png?w=2500&fit=max&auto=format&n=pZecIZCRexa8jqym&q=85&s=bfbe523ac3a401eec116dbb0078bdf06 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-0c00d93d/pZecIZCRexa8jqym/images/cloud/manage/postman/postman7.png?fit=max&auto=format&n=pZecIZCRexa8jqym&q=85&s=4a8fd09fb38aea8ed3f3aa1de1e07422" 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-0c00d93d/pZecIZCRexa8jqym/images/cloud/manage/postman/postman8.png?fit=max&auto=format&n=pZecIZCRexa8jqym&q=85&s=559008b1196deb472f361b112eada9fd" 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-0c00d93d/pZecIZCRexa8jqym/images/cloud/manage/postman/postman9.png?fit=max&auto=format&n=pZecIZCRexa8jqym&q=85&s=89a68f6ff6e81ad16a699b8713767a9d" 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-0c00d93d/pZecIZCRexa8jqym/images/cloud/manage/postman/postman10.png?fit=max&auto=format&n=pZecIZCRexa8jqym&q=85&s=b7cec3d2f7015b77c84df81882cfd4d0" 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-0c00d93d/pZecIZCRexa8jqym/images/cloud/manage/postman/postman11.png?fit=max&auto=format&n=pZecIZCRexa8jqym&q=85&s=90b11cba3853970b3e66fed582d79596" 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-0c00d93d/pZecIZCRexa8jqym/images/cloud/manage/postman/postman12.png?fit=max&auto=format&n=pZecIZCRexa8jqym&q=85&s=b0f0e3f4f4f3c74cfb0fc12f3ed605b8" 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-0c00d93d/pZecIZCRexa8jqym/images/cloud/manage/postman/postman13.png?fit=max&auto=format&n=pZecIZCRexa8jqym&q=85&s=27db68e3150a92e7ddef29790b868edb" 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-0c00d93d/pZecIZCRexa8jqym/images/cloud/manage/postman/postman14.png?fit=max&auto=format&n=pZecIZCRexa8jqym&q=85&s=b04285d478751cf38877e0d3abf05b37" 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-0c00d93d/pZecIZCRexa8jqym/images/cloud/manage/postman/postman15.png?fit=max&auto=format&n=pZecIZCRexa8jqym&q=85&s=89b6737718272c052dd2f124d89d6aa1" 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-0c00d93d/pZecIZCRexa8jqym/images/cloud/manage/postman/postman16.png?fit=max&auto=format&n=pZecIZCRexa8jqym&q=85&s=2de3d48a68998d18b20ea14c50d67f01" 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-0c00d93d/pZecIZCRexa8jqym/images/cloud/manage/postman/postman17.png?fit=max&auto=format&n=pZecIZCRexa8jqym&q=85&s=d512fa5f6b0fad5bcf152868238696fe" 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).
