> ## Documentation Index
> Fetch the complete documentation index at: https://clickhouse.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Gerenciamento de chaves de API

> A ClickHouse Cloud oferece uma API baseada em OpenAPI que permite gerenciar programaticamente sua conta e aspectos dos seus serviços.

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>;
};

ClickHouse Cloud fornece uma API que usa OpenAPI e permite gerenciar programaticamente sua conta e aspectos dos seus serviços.

<Note>
  Este documento aborda a ClickHouse Cloud API. Para endpoints de API de banco de dados, consulte [Cloud Endpoints API](/docs/pt-BR/products/cloud/guides/sql-console/query-endpoints)
</Note>

<Steps>
  <Step title="Abra a página API Keys">
    Você pode usar a aba **API Keys** no menu à esquerda para criar e gerenciar suas chaves de API.

    <Image img="https://mintcdn.com/private-7c7dfe99/REHSqgCLT_igIuJP/images/cloud/manage/openapi1.webp?fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=4b5e224e02e9995b15f410c0b53cc5e7" size="sm" alt="Aba API Keys" border width="433" height="472" data-path="images/cloud/manage/openapi1.webp" />
  </Step>

  <Step title="Comece a criar uma chave de API">
    A página **API Keys** exibirá inicialmente uma solicitação para criar sua primeira chave de API, como mostrado abaixo. Depois que a primeira chave for criada, você poderá criar novas chaves usando o botão `New API Key`, que aparece no canto superior direito.

    <Image img="https://mintcdn.com/private-7c7dfe99/REHSqgCLT_igIuJP/images/cloud/manage/openapi2.webp?fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=3ad9d02d51c9ac4c8b0649027ccf61ec" size="md" alt="Página API Keys" border width="1036" height="466" data-path="images/cloud/manage/openapi2.webp" />
  </Step>

  <Step title="Configure a chave de API">
    Especifique o nome da chave, as permissões e o prazo de expiração.

    <Note>
      As permissões correspondem aos [predefined roles](/docs/pt-BR/products/cloud/reference/security/console-roles) do ClickHouse Cloud. A função developer tem permissões somente leitura para os serviços atribuídos, e a função admin tem permissões completas de leitura e gravação.
    </Note>

    <Tip>
      **Query API Endpoints**

      Para usar chaves de API com [Query API Endpoints](/docs/pt-BR/products/cloud/guides/sql-console/query-endpoints), defina Organization Role como `Member` (no mínimo) e conceda à Service Role acesso a `Query Endpoints`.
    </Tip>

    <Image img="https://mintcdn.com/private-7c7dfe99/C7EtYbvQvbHPGmL5/images/cloud/manage/openapi3.png?fit=max&auto=format&n=C7EtYbvQvbHPGmL5&q=85&s=d85d50665cb229cce53ba16a82a27cd1" size="md" alt="Formulário de criação de chave de API" border width="661" height="410" data-path="images/cloud/manage/openapi3.png" />
  </Step>

  <Step title="Adicione endereços IP permitidos">
    Para restringir quais clientes podem usar a chave de API, na seção **Allow access to this API Key**, selecione **Specific locations**. Insira um endereço IP ou intervalo CIDR, como `203.0.113.1` ou `203.0.113.0/24`, e adicione outras entradas conforme necessário.

    Os Query API endpoints respeitam allowlists de IP no nível da chave de API. Como as requisições são encaminhadas por proxy de dentro da infraestrutura do ClickHouse, allowlists de IP no nível do serviço não se aplicam. Consulte [IP Access Control](/docs/pt-BR/cloud/features/query-api-endpoints#ip-access-control) para mais detalhes.

    <Image img="https://mintcdn.com/private-7c7dfe99/A68-kVUDkVcT2W3b/images/cloud/guides/query-endpoints/specific-locations.webp?fit=max&auto=format&n=A68-kVUDkVcT2W3b&q=85&s=db3d75c39aa5c3e73bc0d23dad7ae25c" size="md" alt="Endereços IP permitidos configurados para uma chave de API" border width="1336" height="1740" data-path="images/cloud/guides/query-endpoints/specific-locations.webp" />

    Clique em **Generate API Key** quando terminar de configurar a chave.
  </Step>

  <Step title="Salve as credenciais da chave de API">
    A próxima tela exibirá seu Key ID e Key secret. Copie esses valores e guarde-os em um local seguro, como um cofre. Eles não serão exibidos novamente depois que você sair desta tela.

    <Image img="https://mintcdn.com/private-7c7dfe99/REHSqgCLT_igIuJP/images/cloud/manage/openapi4.webp?fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=5872535bb69a2299c88f38c627ead497" size="md" alt="Detalhes da chave de API" border width="653" height="271" data-path="images/cloud/manage/openapi4.webp" />
  </Step>

  <Step title="Autentique requisições de API">
    A ClickHouse Cloud API usa [HTTP Basic Authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) para verificar a validade das suas chaves de API. Veja um exemplo de como usar suas chaves de API para enviar requisições à ClickHouse Cloud API com `curl`:

    ```bash theme={null}
    $ KEY_ID=mykeyid
    $ KEY_SECRET=mykeysecret

    $ curl --user $KEY_ID:$KEY_SECRET https://api.clickhouse.cloud/v1/organizations
    ```
  </Step>

  <Step title="Gerencie chaves de API existentes">
    Ao retornar à página **API Keys**, você verá o nome da chave, os quatro últimos caracteres do Key ID, as permissões, o status, a data de expiração e o criador. Nesta tela, você pode editar o nome da chave, as permissões e a expiração. As chaves também podem ser desabilitadas ou excluídas nesta tela.

    <Note>
      Excluir uma chave de API é uma ação permanente. Todos os serviços que usam essa chave perderão imediatamente o acesso ao ClickHouse Cloud.
    </Note>

    <Image img="https://mintcdn.com/private-7c7dfe99/REHSqgCLT_igIuJP/images/cloud/manage/openapi5.webp?fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=e81ed237b99933a115f931acc919c8f8" size="md" alt="Página de gerenciamento de API Keys" border width="1092" height="335" data-path="images/cloud/manage/openapi5.webp" />
  </Step>
</Steps>

<div id="endpoints">
  ## Endpoints
</div>

Para mais detalhes sobre os endpoints, consulte a [referência da API](/docs/pt-BR/products/cloud/api-reference/organization/get-list-of-available-organizations).
Use sua chave de API e seu API Secret com a URL base `https://api.clickhouse.cloud/v1`.