> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-revert-104359-revert-104251-parquet-single.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Acesso programático à API com o Postman

> Este guia ajudará você a testar a API do ClickHouse Cloud usando o 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>;
};

Este guia ajudará você a testar a API do ClickHouse Cloud usando o [Postman](https://www.postman.com/product/what-is-postman/).
O aplicativo Postman pode ser usado no navegador ou baixado para o computador.

<div id="create-an-account">
  ### Criar uma conta
</div>

* Há contas gratuitas disponíveis em [https://www.postman.com](https://www.postman.com).

<Image img="https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman1.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=a83e85bab1c9478ae60b28debee354b2" size="md" alt="Site do Postman" border width="1621" height="1011" data-path="images/cloud/manage/postman/postman1.webp" />

<div id="create-a-workspace">
  ### Criar um espaço de trabalho
</div>

* Dê um nome ao espaço de trabalho e defina o nível de visibilidade.

<Image img="https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman2.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=05d9395d9bbd3f2e46bd83afd7102caa" size="md" alt="Criar espaço de trabalho" border width="784" height="760" data-path="images/cloud/manage/postman/postman2.webp" />

<div id="create-a-collection">
  ### Criar uma coleção
</div>

* No menu no canto superior esquerdo, abaixo de "Explore", clique em "Import":

<Image img="https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman3.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=86ce94530dc6d7cb5da51ce1b51114d5" 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-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman3.webp?w=280&fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=7b18c9b2a26eca9dcbdd780ac11882d4 280w, https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman3.webp?w=560&fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=142cb6eb42e69d071edf36fa467c1f4f 560w, https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman3.webp?w=840&fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=6c58fb4c3beef4015530c82557d66ba2 840w, https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman3.webp?w=1100&fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=d81c9c9658a3ba004379eb80de219b2b 1100w, https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman3.webp?w=1650&fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=b7209dadddebba5f4fbacf92266bb066 1650w, https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman3.webp?w=2500&fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=beb45a440573031b4f91ba9746648379 2500w" />

* Uma janela modal será exibida:

<Image img="https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman4.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=a102d3495baea7db3f8415851922adfc" size="md" alt="Campo de URL da API" border width="659" height="471" data-path="images/cloud/manage/postman/postman4.webp" />

* Insira o endereço da API: "[https://api.clickhouse.cloud/v1](https://api.clickhouse.cloud/v1)" e pressione 'Enter':

* Selecione "Postman Collection" clicando no botão "Import":

<Image img="https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman6.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=5aeb544cb6e4aa206e259235fcf1d3ec" size="md" alt="Collection > 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-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman6.webp?w=280&fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=a4444e0c3ce8d64cde3e77e0b2563077 280w, https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman6.webp?w=560&fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=ba03723432e19d2e321faea706d00392 560w, https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman6.webp?w=840&fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=c79b13133b70b7f780f60628611d1dc1 840w, https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman6.webp?w=1100&fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=4a8d03af4463b1963d82f03665b025a9 1100w, https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman6.webp?w=1650&fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=62c56593e6ab60f29d99629c3a938868 1650w, https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman6.webp?w=2500&fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=bf96c32c57a46060627d6a1085742b8f 2500w" />

<div id="interface-with-the-clickhouse-cloud-api-spec">
  ### Interaja com a especificação da API do ClickHouse Cloud
</div>

* A "API spec for ClickHouse Cloud" agora aparecerá em "Collections" (navegação à esquerda).

<Image img="https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman7.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=106b05bb49433c944fc7c2f599eceefc" size="md" alt="Importe sua API" border width="949" height="446" data-path="images/cloud/manage/postman/postman7.webp" />

* Clique em "API spec for ClickHouse Cloud". No painel central, selecione a guia 'Authorization':

<Image img="https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman8.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=5bc05781c5b4efba03b70765b874ccfd" size="md" alt="Importação concluída" border width="872" height="420" data-path="images/cloud/manage/postman/postman8.webp" />

<div id="set-authorization">
  ### Definir a autorização
</div>

* Use o menu suspenso para selecionar "Basic Auth":

<Image img="https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman9.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=44ec6fbe17b3f31cd4b6dc0671fe2ae9" size="md" alt="Autenticação básica" border width="789" height="620" data-path="images/cloud/manage/postman/postman9.webp" />

* Insira o nome de usuário e a senha que você recebeu ao configurar suas chaves de API do ClickHouse Cloud:

<Image img="https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman10.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=4d4483bd24291db81680101b27085e8e" size="md" alt="credenciais" border width="951" height="700" data-path="images/cloud/manage/postman/postman10.webp" />

<div id="enable-variables">
  ### Habilite as variáveis
</div>

* [Variáveis](https://learning.postman.com/docs/sending-requests/variables/) permitem armazenar e reutilizar valores no Postman, facilitando os testes de API.

<div id="set-the-organization-id-and-service-id">
  #### Defina o ID da organização e o ID do serviço
</div>

* Na "coleção", clique na aba "Variable" no painel central (a Base URL já terá sido definida pela importação anterior da API):
* Abaixo de `baseURL`, clique no campo vazio "Add new value" e substitua pelos IDs da sua organização e do seu serviço:

<Image img="https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman11.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=91355d46e8fac8d57c0d617e657ec3a9" size="md" alt="ID da organização e ID do serviço" border width="1057" height="558" data-path="images/cloud/manage/postman/postman11.webp" />

<div id="test-the-clickhouse-cloud-api-functionalities">
  ## Teste as funcionalidades da API do ClickHouse Cloud
</div>

<div id="test-get-list-of-available-organizations">
  ### Teste "GET list of available organizations"
</div>

* Em "OpenAPI spec for ClickHouse Cloud", expanda a pasta > V1 > organizations
* Clique em "GET list of available organizations" e pressione, à direita, o botão azul "Send":

<Image img="https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman12.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=96ff4d7ea740cc25ce4fb31256e43f29" size="md" alt="Testar a recuperação das organizações" border width="1797" height="972" data-path="images/cloud/manage/postman/postman12.webp" />

* Os resultados retornados devem exibir os detalhes da sua organização com "status": 200. (Se você receber um "status" 400 sem informações da organização, sua configuração não está correta).

<Image img="https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman13.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=949424cb663899a2c913b1b5b621acf4" size="md" alt="Status" border width="1797" height="972" data-path="images/cloud/manage/postman/postman13.webp" />

<div id="test-get-organizational-details">
  ### Teste "GET detalhes organizacionais"
</div>

* Na pasta `organizationid`, navegue até "GET detalhes organizacionais":
* No menu do painel central, em Params, um `organizationid` é obrigatório.

<Image img="https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman14.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=358d1e8b53819a44ea9a5b35aedd3300" size="md" alt="Testar a recuperação de detalhes organizacionais" border width="1797" height="972" data-path="images/cloud/manage/postman/postman14.webp" />

* Edite esse valor para `orgid`, entre chaves: `{{orgid}}` (como esse valor foi definido anteriormente, um menu aparecerá com o valor):

<Image img="https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman15.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=11b67ee3957f28aa2cd605bc4f13e951" size="md" alt="Enviar teste" border width="1797" height="972" data-path="images/cloud/manage/postman/postman15.webp" />

* Após clicar no botão "Save", clique no botão azul "Send" no canto superior direito da tela.

<Image img="https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman16.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=97d42e302acf56c88ba8b5eaeb197659" size="md" alt="Valor retornado" border width="1797" height="972" data-path="images/cloud/manage/postman/postman16.webp" />

* Os resultados retornados devem trazer seus detalhes organizacionais com "status": 200. (Se você receber um "status" 400 sem informações da organização, sua configuração não está correta).

<div id="test-get-service-details">
  ### Teste "GET service details"
</div>

* Clique em "GET service details"
* Edite os valores de `organizationid` e `serviceid` para `{{orgid}}` e `{{serviceid}}`, respectivamente.
* Clique em "Save" e depois no botão azul "Send", à direita.

<Image img="https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman17.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=73c2790abde9d00ddfb5904c02c1aa53" size="md" alt="Lista de serviços" border width="1537" height="867" data-path="images/cloud/manage/postman/postman17.webp" />

* Os resultados retornados devem exibir uma lista dos seus serviços e respectivos detalhes com "status": 200. (Se você receber "status": 400 sem informações dos serviços, sua configuração não está correta).
