> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-postgresql-tls-support.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-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman1.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=2c61508912bc3427c876288254997bb3" 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-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman2.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=89622748f40c1941e50adeed4a81a38d" 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-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman3.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=a273aaf7b93f95ebcef61e11409f6434" 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-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman3.webp?w=280&fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=9f47683f18070b76cb940e34cca4d928 280w, https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman3.webp?w=560&fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=e81a2184eeaf653d7372d493f599bae4 560w, https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman3.webp?w=840&fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=f16fa40356648571f749a4b5707d187f 840w, https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman3.webp?w=1100&fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=9aa34f9b826f5b5c5c97c48afe894813 1100w, https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman3.webp?w=1650&fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=a0bae9c821215eb338109bf377983244 1650w, https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman3.webp?w=2500&fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=7f335120223de12613bcd20c19cf1afe 2500w" />

* Uma janela modal será exibida:

<Image img="https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman4.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=f5d40c45499eefccf3587e7186845b82" 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-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman6.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=a4669236c1c9c9a202f754f84d143276" 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-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman6.webp?w=280&fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=bd61cc099cacc518f8b98f644b803d8a 280w, https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman6.webp?w=560&fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=5125e8451c84e7ca9a6bf04d08de3315 560w, https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman6.webp?w=840&fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=3430f02f162f8022fb32265d89c0adbb 840w, https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman6.webp?w=1100&fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=a33a2aef04da985b28321e76d81c0499 1100w, https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman6.webp?w=1650&fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=89b961ef83d6617643a54b1a4a6bae5b 1650w, https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman6.webp?w=2500&fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=c0fed80b77456329a1e57bf3938cdcc9 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-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman7.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=812230ab7ce9bfadfddb8b953b82d8df" 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-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman8.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=bb01720945db4154d083fd6875df2a4b" 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-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman9.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=f323d24ee610a1a5e4245315ef3ebab4" 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-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman10.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=0eb078fcbf831047fdb7dce17abf2d59" 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 "Collection", 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-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman11.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=1c3eca5c4968569221ccf58e517abd3a" 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, à direita, pressione o botão azul "Send":

<Image img="https://mintcdn.com/private-7c7dfe99-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman12.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=e49bb059e4cfd74a723921eef5806cb3" 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-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman13.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=f79579cbf02220bf0e616273cce74216" 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-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman14.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=091a3bbb2db96383507e7f72981496b5" 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-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman15.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=a5400155eba7b9ca0fdd12a27e1b9c22" 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-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman16.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=5a014d30a4b683e360fc9b30c45abc73" 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-postgresql-tls-support/2QCOf7xGnBQgqjDM/images/cloud/manage/postman/postman17.webp?fit=max&auto=format&n=2QCOf7xGnBQgqjDM&q=85&s=c94295e0a6c7cd5ac8e5cde7e8b94052" 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).
