> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-55d9d317.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-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman1.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=f53a2779dc9e83f8250e97426b9d59cc" 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-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman2.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=977b7c52759645a67f1d8b83fa08d22e" 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-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman3.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=d8f3df9c9cc793605af6c55dc4b65636" 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-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman3.png?w=280&fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=e8d7887e30d038eaaf36a43000db69aa 280w, https://mintcdn.com/private-7c7dfe99-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman3.png?w=560&fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=693e9d292cdc6e12f8d938f0f7050f9a 560w, https://mintcdn.com/private-7c7dfe99-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman3.png?w=840&fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=2d4f5063345589279ce21b6cb0c378b0 840w, https://mintcdn.com/private-7c7dfe99-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman3.png?w=1100&fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=ed549d6637a30e2aee0d25257ca322a8 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman3.png?w=1650&fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=fa364c0bf3e008f8abf0ab4af5e3c295 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman3.png?w=2500&fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=d1c886a84679d7c33ef59a5d9a520f0e 2500w" />

* Uma janela modal será exibida:

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman4.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=cc19090779583f81661a7d8f9a810fea" 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-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman6.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=53b73c4393c2cd377d79aa095dc18b57" 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-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman6.png?w=280&fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=57fc2dea63566ade7f35daa353cff6e0 280w, https://mintcdn.com/private-7c7dfe99-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman6.png?w=560&fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=c24384a96b2fef48a84f53bee9f2bc70 560w, https://mintcdn.com/private-7c7dfe99-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman6.png?w=840&fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=b1f5d02f802bf8c5aa34dfaf6df1ee66 840w, https://mintcdn.com/private-7c7dfe99-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman6.png?w=1100&fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=3c9c3ac415919b049af4e22360391648 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman6.png?w=1650&fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=5f2347fe6eefe582763c61a3aaaaaaa6 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman6.png?w=2500&fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=6c9662295ac496af00ade257b02c7f62 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-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman7.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=e41bcb0056f3b327224b262c7a0c9527" 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-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman8.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=d1c39911a167434f63a3f8ce7d4876f3" 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-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman9.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=78c0753393c1d08da1074c694d69b257" 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-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman10.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=a0121ff2e764a7dafdc9d2ec7f7603b7" 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-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman11.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=3e88a45897fa4fe0335b5d4166507a87" 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-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman12.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=1016682b22b9f744825fefceef436319" 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-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman13.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=9a6366dea1c2fb515cd4e98e19781ec2" 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-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman14.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=7a3647286a741cf48c43ea364da99051" 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-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman15.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=8b406c77099ec3528f04a4ad90ac419c" 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-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman16.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=acfd69542be767fef0993d87dfe66743" 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-mintlify-55d9d317/r-pB9n2znEN9vc8S/images/cloud/manage/postman/postman17.png?fit=max&auto=format&n=r-pB9n2znEN9vc8S&q=85&s=04bd7250960e7f3e0d895f982c013914" 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).
