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

# 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-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="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-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="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-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" />

* Se abrirá una ventana modal:

<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="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-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="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-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">
  ### 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-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="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-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="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-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" />

* 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-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="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-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 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-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="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-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="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-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="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-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="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-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="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-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="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).
