> For the complete documentation index, see [llms.txt](https://docs.kiloiot.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.kiloiot.io/kilo-docs-pt/kilo-iot-server/api/authentication-and-api-keys.md).

# Autenticação e Chaves de API

Autentique pedidos à API Kilo IoT com chaves com âmbito — cabeçalhos X-API-Key e X-Organization-Id, chaves por integração.

Cada pedido de API — REST ou gRPC — é autenticado com uma **chave de API com escopo**. Crie, atribua escopos, rode e revogue chaves em [Definições → Chaves de API](/kilo-docs-pt/kilo-iot-server/settings/api-keys.md); esta página explica como os pedidos se autenticam.

## Como os pedidos se autenticam

* **`X-API-Key`** — a sua chave de API (formato `kilo_<key>`). Envie-a em todos os pedidos.
* **`X-Organization-Id`** — a organização em que o pedido atua. Tem de corresponder à organização em que a chave foi criada. Algumas operações também aceitam a organização como um `organizationId` parâmetro de consulta em vez do cabeçalho.

Todos os pedidos são feitos sobre TLS.

## Âmbitos

As chaves têm escopos. A maioria das áreas tem **Leitura** e **Escrita** escopos separados; alguns — como telemetria e dados de subscrição — são apenas de leitura. Uma chave concede apenas o que seleciona quando a cria, por isso conceda apenas os escopos de que a integração precisa. Cada endpoint no [referência da API](https://api.kiloiot.io/) indica o escopo de que necessita.

A **Criar chave de API** a caixa de diálogo pede um nome, uma data de expiração opcional e os próprios escopos — cada escopo começa desmarcado, por isso uma chave não concede nada até que o indique.

<figure><img src="https://585438662-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtNQh1wBSHSaknslMdOXm%2Fuploads%2Fgit-blob-e2e31de97adacb0b0d949199c29378c195801c26%2Fapi-key-create-scopes.jpg?alt=media" alt="The Create API Key dialog with the name and expiry fields above the list of read and write scopes"><figcaption></figcaption></figure>

## Como gerir chaves em segurança

* O valor completo da chave é mostrado **uma vez** na criação; depois disso, só fica visível um pequeno prefixo. Guarde-o imediatamente num gestor de segredos ou cofre.
* Use uma **chave separada por integração** para que uma possa ser revogada sem interromper as outras.
* **Rode ou revogue** uma chave imediatamente se puder ter sido exposta; a rotação é o único caminho de recuperação para uma chave perdida.
* Nunca incorpore uma chave no código do lado do cliente nem a submeta ao controlo de versões.


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.kiloiot.io/kilo-docs-pt/kilo-iot-server/api/authentication-and-api-keys.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
