> 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/public-rest-api.md).

# API REST Pública

API REST pública do Kilo IoT Server — superfície principal de integração via HTTPS/JSON com X-API-Key e X-Organization-Id.

A API REST é a forma principal de integrar o Kilo IoT Server com sistemas externos através de HTTPS standard. Qualquer linguagem ou ferramenta que possa fazer um pedido HTTP autenticado pode utilizá-la — serviços de backend, pipelines de dados, tarefas de relatório e ferramentas operacionais.

Use a [referência da API](https://api.kiloiot.io/) para a lista completa de endpoints, parâmetros de pedido, esquemas de resposta e âmbitos necessários.

## Endpoint base e autenticação

Os pedidos são enviados para o endpoint de produção seguro e incluem dois cabeçalhos:

* `X-API-Key` — uma chave com âmbito criada em [Definições → Chaves de API](/kilo-docs-pt/kilo-iot-server/settings/api-keys.md).
* `X-Organization-Id` — a organização em que o pedido opera; deve corresponder à organização da chave. Algumas operações também aceitam a organização como um `organizationId` parâmetro de consulta em vez do cabeçalho.

Todo o tráfego é realizado sobre TLS. Trate a chave como uma credencial — consulte [Autenticação e chaves de API](/kilo-docs-pt/kilo-iot-server/api/authentication-and-api-keys.md).

## O que a API pode fazer

REST é a interface principal e mais abrangente. Sujeitas aos âmbitos concedidos à chave, as integrações podem funcionar em toda a plataforma — por exemplo: ler o perfil da conta/utilizador; listar e gerir dispositivos e a sua **configuração do dispositivo físico** (o ID do dispositivo cliente, a ligação à qual está associado e as definições específicas da ligação), os seus sensores e mapeamentos de sensores, e modelos de sensores; ler sensor **histórico e último contacto** valores; ler definições de conectores e gerir ligações; ler e gerir painéis e widgets; ler dados de organização, membros e subscrição; ler e gerir automação **definições de regras, bem como as respetivas versões e compilações**; e definir e enviar **comandos de dispositivo** para controlar o hardware.

Para integrações tipadas entre serviços ou no local, consulte [API gRPC](/kilo-docs-pt/kilo-iot-server/api/grpc-api.md).

## Fluxo de trabalho

1. Crie uma chave com âmbito em [Definições → Chaves de API](/kilo-docs-pt/kilo-iot-server/settings/api-keys.md) e armazene-a com segurança.
2. Encontre a operação de que precisa na referência da API.
3. Chame-a com `X-API-Key` e `X-Organization-Id`.
4. Trate os códigos de estado HTTP standard e as respostas JSON.

Uma chamada autenticada mínima está em [Exemplos](/kilo-docs-pt/kilo-iot-server/api/examples.md).

## Ver também

* [API gRPC](/kilo-docs-pt/kilo-iot-server/api/grpc-api.md) — quando clientes tipados ou chamadas entre serviços se adequam melhor.
* [Autenticação e chaves de API](/kilo-docs-pt/kilo-iot-server/api/authentication-and-api-keys.md)
* [Chaves de API](/kilo-docs-pt/kilo-iot-server/settings/api-keys.md) — criar e gerir chaves.


---

# 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/public-rest-api.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.