> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-trino-dialect.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-trino-dialect/tyM7Sy7bE2MbONr4/images/cloud/manage/postman/postman1.webp?fit=max&auto=format&n=tyM7Sy7bE2MbONr4&q=85&s=38e4f2d491b71379d53e81758122ba84" 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-trino-dialect/tyM7Sy7bE2MbONr4/images/cloud/manage/postman/postman2.webp?fit=max&auto=format&n=tyM7Sy7bE2MbONr4&q=85&s=8c3d86985cb259d9a2ac1c300754b8d2" 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-trino-dialect/tyM7Sy7bE2MbONr4/images/cloud/manage/postman/postman3.webp?fit=max&auto=format&n=tyM7Sy7bE2MbONr4&q=85&s=884ad237c4b24a204898ef6c654b1276" 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-trino-dialect/tyM7Sy7bE2MbONr4/images/cloud/manage/postman/postman3.webp?w=280&fit=max&auto=format&n=tyM7Sy7bE2MbONr4&q=85&s=3b8f5c5708be1ea7a006931cd2beffd1 280w, https://mintcdn.com/private-7c7dfe99-trino-dialect/tyM7Sy7bE2MbONr4/images/cloud/manage/postman/postman3.webp?w=560&fit=max&auto=format&n=tyM7Sy7bE2MbONr4&q=85&s=e7f33e1d2e3e9a427a2330ccca56864a 560w, https://mintcdn.com/private-7c7dfe99-trino-dialect/tyM7Sy7bE2MbONr4/images/cloud/manage/postman/postman3.webp?w=840&fit=max&auto=format&n=tyM7Sy7bE2MbONr4&q=85&s=2f85a3a242893f9d7569ab2447066907 840w, https://mintcdn.com/private-7c7dfe99-trino-dialect/tyM7Sy7bE2MbONr4/images/cloud/manage/postman/postman3.webp?w=1100&fit=max&auto=format&n=tyM7Sy7bE2MbONr4&q=85&s=d082f765263e7378a72ce7d090912f50 1100w, https://mintcdn.com/private-7c7dfe99-trino-dialect/tyM7Sy7bE2MbONr4/images/cloud/manage/postman/postman3.webp?w=1650&fit=max&auto=format&n=tyM7Sy7bE2MbONr4&q=85&s=72ce179337d7c2a8a5fd4f785053c875 1650w, https://mintcdn.com/private-7c7dfe99-trino-dialect/tyM7Sy7bE2MbONr4/images/cloud/manage/postman/postman3.webp?w=2500&fit=max&auto=format&n=tyM7Sy7bE2MbONr4&q=85&s=bcad0fec0648cab46bf8a34dd75da54d 2500w" />

* Se abrirá una ventana modal:

<Image img="https://mintcdn.com/private-7c7dfe99-trino-dialect/tyM7Sy7bE2MbONr4/images/cloud/manage/postman/postman4.webp?fit=max&auto=format&n=tyM7Sy7bE2MbONr4&q=85&s=5858fe5d78d42c3c8b76522eef14d915" 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-trino-dialect/tyM7Sy7bE2MbONr4/images/cloud/manage/postman/postman6.webp?fit=max&auto=format&n=tyM7Sy7bE2MbONr4&q=85&s=1c5c7384425eed9cd8487a20de7807cf" 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-trino-dialect/tyM7Sy7bE2MbONr4/images/cloud/manage/postman/postman6.webp?w=280&fit=max&auto=format&n=tyM7Sy7bE2MbONr4&q=85&s=60b99ac3fe05d0fc7262dd69495dc737 280w, https://mintcdn.com/private-7c7dfe99-trino-dialect/tyM7Sy7bE2MbONr4/images/cloud/manage/postman/postman6.webp?w=560&fit=max&auto=format&n=tyM7Sy7bE2MbONr4&q=85&s=e61840ee8dde8418805ad36278b8d152 560w, https://mintcdn.com/private-7c7dfe99-trino-dialect/tyM7Sy7bE2MbONr4/images/cloud/manage/postman/postman6.webp?w=840&fit=max&auto=format&n=tyM7Sy7bE2MbONr4&q=85&s=21701fc1260469002bf08401d38c8105 840w, https://mintcdn.com/private-7c7dfe99-trino-dialect/tyM7Sy7bE2MbONr4/images/cloud/manage/postman/postman6.webp?w=1100&fit=max&auto=format&n=tyM7Sy7bE2MbONr4&q=85&s=c2e30cb8a2f296d19702b82ed6886ec4 1100w, https://mintcdn.com/private-7c7dfe99-trino-dialect/tyM7Sy7bE2MbONr4/images/cloud/manage/postman/postman6.webp?w=1650&fit=max&auto=format&n=tyM7Sy7bE2MbONr4&q=85&s=4b3c3c28c889c129f911b272dd5ec3f0 1650w, https://mintcdn.com/private-7c7dfe99-trino-dialect/tyM7Sy7bE2MbONr4/images/cloud/manage/postman/postman6.webp?w=2500&fit=max&auto=format&n=tyM7Sy7bE2MbONr4&q=85&s=149ec299ea3657b1e7f654b8b63819a5 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-trino-dialect/tyM7Sy7bE2MbONr4/images/cloud/manage/postman/postman7.webp?fit=max&auto=format&n=tyM7Sy7bE2MbONr4&q=85&s=1dd51b1595bd10953fe16a649432feb8" 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-trino-dialect/tyM7Sy7bE2MbONr4/images/cloud/manage/postman/postman8.webp?fit=max&auto=format&n=tyM7Sy7bE2MbONr4&q=85&s=fb40fea7dab3dbb57924f2aa02e30a10" 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-trino-dialect/tyM7Sy7bE2MbONr4/images/cloud/manage/postman/postman9.webp?fit=max&auto=format&n=tyM7Sy7bE2MbONr4&q=85&s=4758319b996b0ee90f3fd20ec0ecf00a" 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-trino-dialect/tyM7Sy7bE2MbONr4/images/cloud/manage/postman/postman10.webp?fit=max&auto=format&n=tyM7Sy7bE2MbONr4&q=85&s=d3baea4f2e1ad6ea9798806d61bf86b4" 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-trino-dialect/tyM7Sy7bE2MbONr4/images/cloud/manage/postman/postman11.webp?fit=max&auto=format&n=tyM7Sy7bE2MbONr4&q=85&s=789df588d0f6a74dda1f378c04004937" 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-trino-dialect/tyM7Sy7bE2MbONr4/images/cloud/manage/postman/postman12.webp?fit=max&auto=format&n=tyM7Sy7bE2MbONr4&q=85&s=92b7a3dca0b3b9ccf42528611e547e30" 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-trino-dialect/tyM7Sy7bE2MbONr4/images/cloud/manage/postman/postman13.webp?fit=max&auto=format&n=tyM7Sy7bE2MbONr4&q=85&s=d98ff98f5915b298afe07f1c909b6998" 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-trino-dialect/tyM7Sy7bE2MbONr4/images/cloud/manage/postman/postman14.webp?fit=max&auto=format&n=tyM7Sy7bE2MbONr4&q=85&s=eb32ef4359f14eeb704742c659767fc0" 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-trino-dialect/tyM7Sy7bE2MbONr4/images/cloud/manage/postman/postman15.webp?fit=max&auto=format&n=tyM7Sy7bE2MbONr4&q=85&s=2674ea59d3082af1a1d7a1c51c46c715" 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-trino-dialect/tyM7Sy7bE2MbONr4/images/cloud/manage/postman/postman16.webp?fit=max&auto=format&n=tyM7Sy7bE2MbONr4&q=85&s=e9fb22cdd72e6397e9165f7a7fe24296" 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-trino-dialect/tyM7Sy7bE2MbONr4/images/cloud/manage/postman/postman17.webp?fit=max&auto=format&n=tyM7Sy7bE2MbONr4&q=85&s=9364740b80faf5e94f31453ef7f79340" 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).
