> For the complete documentation index, see [llms.txt](https://docs.docbits.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.docbits.com/portuguese/administration-and-setup/settings/global-settings/integration/api-key-management.md). # Gestão de Chaves API Como encontrar e criar as chaves API que dão a outros sistemas acesso ao DocBits Uma API key permite que outro sistema — o seu ERP, um script ou uma aplicação de um parceiro — fale com o DocBits sem que um utilizador inicie sessão. A sua organização pode ter tantas chaves quantas precisar, e cada uma é gerida em separado: dê-lhe um nome próprio, decida se expira e revogue-a isoladamente se alguma vez for exposta. Como cada integração pode ter a sua própria chave, pode desligar uma sem perturbar nenhuma das outras. ## Abrir a gestão de chaves API Vá a **Settings** e selecione **Integration & SSO** em **System & Administration**. ![](https://raw.githubusercontent.com/Fellow-Consulting-AG/docbits/refs/heads/main/readme/.gitbook/assets/api-key-settings-overview.png) A secção **API Key** no topo da página lista todas as chaves que a sua organização tem. ![](https://raw.githubusercontent.com/Fellow-Consulting-AG/docbits/refs/heads/main/readme/.gitbook/assets/api-key-list.png) ## Compreender a lista ![](https://raw.githubusercontent.com/Fellow-Consulting-AG/docbits/refs/heads/main/readme/.gitbook/assets/api-key-list-row.png) | Coluna | O que lhe diz | | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Key** | Os primeiros caracteres da chave, seguidos de `****`. O resto nunca mais é mostrado depois de a criar — consulte [Criar uma chave API](#criar-uma-chave-api). | | **Name** | O nome que deu à chave, com a descrição por baixo. | | **Expires** | A data em que a chave deixa de funcionar, ou **Never** se não tiver definido nenhuma. | | **Last Used** | Quando chegou pela última vez um pedido com esta chave. **Never used** significa que nenhum sistema a usou ainda — útil para detetar chaves que pode remover com segurança. | | **Status** | **Active** significa que a chave funciona. Uma chave revogada fica desligada permanentemente. | | **Actions** | O menu de três pontos, onde pode revogar a chave. | Se tiver mais chaves do que cabem numa página, use os controlos de paginação no fundo da lista. {% hint style="info" %} **Last Used** é a forma mais rápida de encontrar chaves de que já ninguém precisa. Uma chave que nunca foi usada, ou que não é usada há meses, é uma boa candidata a revogação. {% endhint %} ## Criar uma chave API 1. Clique em **+ Create API Key** no canto superior direito da secção API Keys. 2. Preencha a caixa de diálogo: ![](https://raw.githubusercontent.com/Fellow-Consulting-AG/docbits/refs/heads/main/readme/.gitbook/assets/api-key-create-dialog.png) | Campo | O que introduzir | | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Key Name** | Obrigatório. Dê-lhe o nome do sistema que a vai usar — `M3 Production`, `Invoice Import Script` — para conseguir perceber mais tarde a que integração pertence cada chave. | | **Description** | Opcional. Espaço para uma nota sobre para que serve a chave ou quem a configurou. | | **Expiration** | Escolha uma data de expiração, ou deixe em **Never expires**. Uma data de expiração é a opção mais segura: a chave reforma-se sozinha se a integração alguma vez for esquecida. | 3. Clique em **Create**. O DocBits mostra-lhe a nova chave: ![](https://raw.githubusercontent.com/Fellow-Consulting-AG/docbits/refs/heads/main/readme/.gitbook/assets/api-key-created.png) 4. Copie a chave com o ícone de cópia e cole-a diretamente no sistema que a vai usar, ou no seu gestor de palavras-passe. 5. Assinale **I have copied and saved this key** e clique em **Done**. {% hint style="danger" %} **A chave completa é mostrada apenas uma vez.** O DocBits guarda um hash unidirecional da chave e um prefixo curto para identificação. Nem os seus administradores nem o suporte do DocBits podem recuperar a chave original completa a partir desse hash. Se a perder, revogue-a e crie uma nova. {% endhint %} Trate a chave como uma palavra-passe. Qualquer pessoa que a tenha pode atuar sobre os documentos e os dados da sua organização. Consulte [Armazenamento seguro de credenciais](/portuguese/security/secure-storage-of-credentials.md). --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.docbits.com/portuguese/administration-and-setup/settings/global-settings/integration/api-key-management.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.