> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-vortex-format.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 = "lg"}) => {
  const normalizedSize = ["sm", "md", "lg"].includes(size) ? size : "lg";
  return <div className={`ch-image-${normalizedSize}`}>
      <Frame>
        <img src={img} alt={alt} />
      </Frame>
    </div>;
};

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>

* Hay cuentas gratuitas disponibles en [https://www.postman.com](https://www.postman.com).

<Image img="https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman1.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=8f3f7cda47c0f3ac898de4e2fd5d9248" size="md" alt="Sitio de Postman" border width="1621" height="1011" data-path="images/cloud/manage/postman/postman1.webp" />

<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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman2.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=062e8c49f4bd698c7ae558c17db3f6e9" size="md" alt="Crear un espacio de trabajo" border width="784" height="760" data-path="images/cloud/manage/postman/postman2.webp" />

<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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman3.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=52dd7913c382f5695f82b96ddd06db54" 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.webp" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman3.webp?w=280&fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=95cad0f9ebefd3a779c846787b33a680 280w, https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman3.webp?w=560&fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=b36f360b8e3813cce3e4387f881ff221 560w, https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman3.webp?w=840&fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=2ac8e3e37c8c9f7ab507cd345e0b488d 840w, https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman3.webp?w=1100&fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=210a32cb766037792e07d356f180a684 1100w, https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman3.webp?w=1650&fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=04b240c713b08625e3d334df37a61775 1650w, https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman3.webp?w=2500&fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=4ae5ee8a7a8898a961a9d88482c40c76 2500w" />

* Se abrirá una ventana modal:

<Image img="https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman4.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=e72a652da17e4254e0d16844d40519f0" size="md" alt="Campo de URL de la API" border width="659" height="471" data-path="images/cloud/manage/postman/postman4.webp" />

* 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman6.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=47f9f21353bc481924d8c7ef150b510c" 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.webp" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman6.webp?w=280&fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=6d23976c84a141270b6b585acd7bcdba 280w, https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman6.webp?w=560&fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=490207378dbc4ca7c05a9aeade0b8187 560w, https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman6.webp?w=840&fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=18c5d07a8a32e953aadec2c263c4ffb9 840w, https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman6.webp?w=1100&fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=a1fb6d7da8ea6b3600a9aa727030c0fa 1100w, https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman6.webp?w=1650&fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=075801c79cb4beb287594df00e36f7f1 1650w, https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman6.webp?w=2500&fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=d9ea8b0fe14b1eaa42fa3fbbcceb04f1 2500w" />

<div id="interface-with-the-clickhouse-cloud-api-spec">
  ### Interactúa con la especificación de la API de ClickHouse Cloud
</div>

* La "especificación de la API de ClickHouse Cloud" ahora aparecerá en "Collections" (navegación izquierda).

<Image img="https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman7.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=65ec25c0cf1e2a2ebe433ec6b24a7286" size="md" alt="Importa tu API" border width="949" height="446" data-path="images/cloud/manage/postman/postman7.webp" />

* Haz clic en "especificación de la API de ClickHouse Cloud". En el panel central, selecciona la pestaña "Authorization":

<Image img="https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman8.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=0b75da2501a9a7eba9544bbb0c49eae5" size="md" alt="Importación completada" border width="872" height="420" data-path="images/cloud/manage/postman/postman8.webp" />

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

* Abre el menú desplegable y selecciona "Basic Auth":

<Image img="https://mintcdn.com/private-7c7dfe99-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman9.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=86c17d0b773deebe08646fbb80e77a13" size="md" alt="Basic auth" border width="789" height="620" data-path="images/cloud/manage/postman/postman9.webp" />

* 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman10.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=91beb8e82dca2bad3d0b89516ca1b69a" size="md" alt="credenciales" border width="951" height="700" data-path="images/cloud/manage/postman/postman10.webp" />

<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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman11.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=1371acd604d4b7ebbf14de39dad2d722" size="md" alt="ID de la organización e ID del servicio" border width="1057" height="558" data-path="images/cloud/manage/postman/postman11.webp" />

<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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman12.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=70787f1f11fb6874d6e9bd77b00ee56c" size="md" alt="Prueba de obtención de organizaciones" border width="1797" height="972" data-path="images/cloud/manage/postman/postman12.webp" />

* 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman13.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=c32fea48083184a371b5b76868c50905" size="md" alt="Estado" border width="1797" height="972" data-path="images/cloud/manage/postman/postman13.webp" />

<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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman14.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=f2bc64f9ab7fb1c6dec11eb2f6bff131" 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.webp" />

* 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman15.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=f55000c865aefd2c971b7827e5f87b75" size="md" alt="Enviar prueba" border width="1797" height="972" data-path="images/cloud/manage/postman/postman15.webp" />

* 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman16.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=cff855b3498fe90ecd392a143b4069d6" size="md" alt="Valor devuelto" border width="1797" height="972" data-path="images/cloud/manage/postman/postman16.webp" />

* 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-vortex-format/N5J92FpLvYKK3vEv/images/cloud/manage/postman/postman17.webp?fit=max&auto=format&n=N5J92FpLvYKK3vEv&q=85&s=e94dfd37404478034257b2065fba06ae" size="md" alt="Lista de servicios" border width="1537" height="867" data-path="images/cloud/manage/postman/postman17.webp" />

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