> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-home-button.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}) => {
  return <Frame>
      <img src={img} alt={alt} />
    </Frame>;
};

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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman1.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=77d3157a1cfe42f7e9b28c981a81935e" size="md" alt="Site do Postman" border width="1621" height="1011" data-path="images/cloud/manage/postman/postman1.png" />

<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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman2.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=4131eaed5f5a1e2ddd3adcca933bb8da" size="md" alt="Criar espaço de trabalho" border width="784" height="760" data-path="images/cloud/manage/postman/postman2.png" />

<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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman3.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=44fbb20ba7036e2da71fc77c626795a1" 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman3.png?w=280&fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=b06045611848e39066fefd55d978f2a5 280w, https://mintcdn.com/private-7c7dfe99-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman3.png?w=560&fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=05e721ade1be264a4301a6be381ed1c3 560w, https://mintcdn.com/private-7c7dfe99-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman3.png?w=840&fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=669c4ff5117bb760981ecee813d4a490 840w, https://mintcdn.com/private-7c7dfe99-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman3.png?w=1100&fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=18a3337f054e6dee7d55ad728cbd45ca 1100w, https://mintcdn.com/private-7c7dfe99-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman3.png?w=1650&fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=86c34c1032b32abc61c597ac956e9e8b 1650w, https://mintcdn.com/private-7c7dfe99-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman3.png?w=2500&fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=94e62964db90315641496541a4f62cf4 2500w" />

* Uma janela modal será exibida:

<Image img="https://mintcdn.com/private-7c7dfe99-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman4.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=5e16cfd929a754d87204fb811878001f" size="md" alt="Campo de URL da API" border width="659" height="471" data-path="images/cloud/manage/postman/postman4.png" />

* 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman6.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=9d5ac92c7d0c15b4675913aebddc9fbc" 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.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/private-7c7dfe99-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman6.png?w=280&fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=42a2b0db5d51e1e314e0e66a3a019f47 280w, https://mintcdn.com/private-7c7dfe99-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman6.png?w=560&fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=5025d993d2303c81bdedeb1cfba17a34 560w, https://mintcdn.com/private-7c7dfe99-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman6.png?w=840&fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=153854c0e103ee8f0841167f5bcc8a1c 840w, https://mintcdn.com/private-7c7dfe99-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman6.png?w=1100&fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=f30dbc5c2761b4f1c2a1dd23ac19017d 1100w, https://mintcdn.com/private-7c7dfe99-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman6.png?w=1650&fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=eb24de1783e29f0e59f733450a3c1f48 1650w, https://mintcdn.com/private-7c7dfe99-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman6.png?w=2500&fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=ac6c8369b7caf9cfbfe71ed6a8ac3d75 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman7.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=f086508386a377720d146bcf8b9441b2" size="md" alt="Importe sua API" border width="949" height="446" data-path="images/cloud/manage/postman/postman7.png" />

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

<Image img="https://mintcdn.com/private-7c7dfe99-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman8.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=e1c17b85cc2b0ee664efb8d940ab041c" size="md" alt="Importação concluída" border width="872" height="420" data-path="images/cloud/manage/postman/postman8.png" />

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

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

<Image img="https://mintcdn.com/private-7c7dfe99-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman9.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=74da95f55efb73c8aa2d251da6c2f893" size="md" alt="Autenticação básica" border width="789" height="620" data-path="images/cloud/manage/postman/postman9.png" />

* 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman10.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=40fb93b899c532ed89e25e60d71ded6f" size="md" alt="credenciais" border width="951" height="700" data-path="images/cloud/manage/postman/postman10.png" />

<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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman11.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=2286880fdfd03b7098021125a6236307" size="md" alt="ID da organização e ID do serviço" border width="1057" height="558" data-path="images/cloud/manage/postman/postman11.png" />

<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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman12.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=3b32e72c51d50157eedb7de366eac8cf" size="md" alt="Testar a recuperação das organizações" border width="1797" height="972" data-path="images/cloud/manage/postman/postman12.png" />

* 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman13.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=05c4e3e08c42c46ec3d18cae5f3fe03f" size="md" alt="Status" border width="1797" height="972" data-path="images/cloud/manage/postman/postman13.png" />

<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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman14.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=e0f4ff172530473943c3b56d7fb4d7fb" size="md" alt="Testar a recuperação de detalhes organizacionais" border width="1797" height="972" data-path="images/cloud/manage/postman/postman14.png" />

* 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman15.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=7ff48499b7cc734aa26a8bfd72a2a412" size="md" alt="Enviar teste" border width="1797" height="972" data-path="images/cloud/manage/postman/postman15.png" />

* 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman16.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=bfef37298052fce5568ae1081ce2417f" size="md" alt="Valor retornado" border width="1797" height="972" data-path="images/cloud/manage/postman/postman16.png" />

* 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman17.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=7c72eb426205aced4a39c544e12f4805" size="md" alt="Lista de serviços" border width="1537" height="867" data-path="images/cloud/manage/postman/postman17.png" />

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