> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-c8329da0.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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman1.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=65d256810e670208add0334718b2eade" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman2.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=446caace67dccacb4d28b28e516d418d" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman3.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=004a2241b310b1ec8fa9722844949305" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman3.png?w=280&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=6ef56d6da15b1d3da7d219fe642a27f2 280w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman3.png?w=560&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=c40832cbbf445839ab1c9e584ac805ca 560w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman3.png?w=840&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=b8193a35bc84753e9f7220ba0e842905 840w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman3.png?w=1100&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=4755e1bf325457625aa3be6fd1f09df2 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman3.png?w=1650&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=299dd63e76da7e1dc8e2b3f8194d4ee8 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman3.png?w=2500&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=63e44a478821e436e583620728c3d0c7 2500w" />

* Uma janela modal será exibida:

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman4.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=0bafe43b4e9d219f8fb615668b117495" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman6.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=9dc63d6d676d83f1c1137f5f8dbf7c21" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman6.png?w=280&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=897e27bbaa7f4e4ba4a42ee807a5d3f3 280w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman6.png?w=560&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=627d57d47e4e5aa4f2c08b00c1bc0577 560w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman6.png?w=840&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=d1b20e7204e21134a3d3604c61588498 840w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman6.png?w=1100&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=428ef7604312c40554dcce14a7980f6a 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman6.png?w=1650&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=6f98637ef222eb53466e5cc343b0f6b7 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman6.png?w=2500&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=425e628b214ef48995804e431fd01ed9 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman7.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=1147b1757b75c08e52e6248a48b94efd" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman8.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=266b15b57b7799d1387f4db90322890b" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman9.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=0131d169045256ca4e9bbab96de833fb" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman10.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=139a0032880a770a7f39903c3af784ed" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman11.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=56a9bc674828b6d7731dfb450744a5e8" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman12.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=fd89d9ae629cd14ea78b68b919f0dd65" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman13.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=58e1885423c6f781bbdf85fe2272a5f9" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman14.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=8a236769bc9f1a30fafc8b1463bb4bff" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman15.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=5c14fbfecae5fc900026be98f6bee10f" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman16.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=064ff0dc0b16529dc64aca5bff2c6c89" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman17.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=d784c5cd4dbc5555b06e981dc47774b6" 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).
