> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-fix-nav-issues.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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman1.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=a17ff568428176d30a9c8aa80133b55d" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman2.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=243d343725a3aa49c70181399c336cdd" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman3.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=42d77d7c32716e4e481bbacfb42b565d" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman3.png?w=280&fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=e1e1159867baabde04b1a80549eaf3a1 280w, https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman3.png?w=560&fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=d8e1bb3c4c741c42676a435765f6b7a3 560w, https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman3.png?w=840&fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=bbf7ea77ab6fd64a112c8cfb33658165 840w, https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman3.png?w=1100&fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=edfbddeeb2c5245520df1e9f8e46d261 1100w, https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman3.png?w=1650&fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=f642661811641883587cd3869581c067 1650w, https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman3.png?w=2500&fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=47fde21dd9031cc1738046a584204ceb 2500w" />

* Se abrirá una ventana modal:

<Image img="https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman4.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=7a972d25323b766b3a1cd685e72d17ce" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman6.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=b2f69bc914e1c62a55189d09302daac6" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman6.png?w=280&fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=c51dbbcddbd62046357f90fbbe8b4e12 280w, https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman6.png?w=560&fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=ab5c03ed0049c9afd4d25269129f358b 560w, https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman6.png?w=840&fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=9fd7596109a0702b484291195e46b232 840w, https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman6.png?w=1100&fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=b80c7029ef892192b7baaeda77d5a528 1100w, https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman6.png?w=1650&fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=f90bbd7e34739b175e3fee4c6f34df6e 1650w, https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman6.png?w=2500&fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=f27a3d978a3834f8ad8c24b2e5bf5978 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman7.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=b6dac29e785b0ea50924d23b6b7d7769" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman8.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=d0329f48484f8e40be650a57b948d128" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman9.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=c113ffb2cf0e4f1a2ff0a29265f0805b" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman10.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=b6f43307a0d912bc8051d2f2a796e7f6" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman11.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=ce74d088c994be1bae8b29d1bbacce3a" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman12.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=0743c41540a2d80a028b63d566894a7e" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman13.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=08627f71b293e5ebc3fa2d49f5b5bd91" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman14.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=7998a141ad4986a9863ad7b8f85599de" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman15.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=774209dae04db0793b5a3c98da8f2f48" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman16.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=622d3f0f5b3a7fedb95fa2448faa691c" 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-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/postman/postman17.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=78bbf324adf043fa74ce951564edb1f9" 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).
