> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-detect-table-modification.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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman1.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=e72b02c9a09b332543342a976050a598" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman2.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=422dc9b811724600a51e1d1a06d6715a" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman3.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=a7d14257917557203e22bada43717d21" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman3.webp?w=280&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=ac2f100cbe86e984d3b66a308146f0cd 280w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman3.webp?w=560&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=542f48107296f4485736c59604593208 560w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman3.webp?w=840&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=ed138923ff712a2e09492ed31ef9edf9 840w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman3.webp?w=1100&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=f1efa5f6abd08c2e14d38cda0d4e36dc 1100w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman3.webp?w=1650&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=4b72f67d2ac0bbb25f071a3b73dbf534 1650w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman3.webp?w=2500&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=ea1bce2f113aa7d3ab29fe0c78b8e353 2500w" />

* Uma janela modal será exibida:

<Image img="https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman4.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=38d7979ba98296590d9c876c7d6bbccb" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman6.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=6bd414437c263a49d05d55300aa41607" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman6.webp?w=280&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=5149e81347497a0df7d06f060b99b822 280w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman6.webp?w=560&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=7ba9aa5b66c74bee6730f21bee456316 560w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman6.webp?w=840&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=de244832ed3f24daadd81afad9bac75e 840w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman6.webp?w=1100&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=72fa09b007806eca09e1da831735efde 1100w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman6.webp?w=1650&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=6b85cbf014b4428de85fcc4f48d2f5e6 1650w, https://mintcdn.com/private-7c7dfe99-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman6.webp?w=2500&fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=ba79eab2e06318ccd050a81e94b9fe7e 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman7.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=f432316604acb31ef159bd741f2da343" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman8.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=c2b4bef760535aaaf9e07c87f6e82bbf" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman9.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=46e01ea2fabaf65a6da25e766da0df9e" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman10.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=eaef923ed7870f4961a1eabbd833b847" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman11.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=1e0c8d519c256c952ee61ec294cc35b6" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman12.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=99392d42cebe9764355dfae7651ece65" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman13.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=ad80488a9cf6ba5ba56d515f1eeb3a1e" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman14.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=58f20cc3221acecc731381238beef8f5" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman15.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=d7e951fe258b988a3c81a6d8dd9c8e0e" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman16.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=b9a490e9416289f5f465372cfeb910f7" 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-detect-table-modification/I0yKDIFW2QfsHJIe/images/cloud/manage/postman/postman17.webp?fit=max&auto=format&n=I0yKDIFW2QfsHJIe&q=85&s=a5f2ad863c44e1871bcb6ae45689304a" 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).
