> For the complete documentation index, see [llms.txt](https://portal-integracao.intelbras.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://portal-integracao.intelbras.com.br/api-inc-cloud/introducao.md).

# Introdução

Visão geral da API REST da plataforma INC Cloud.

A **INC Cloud API** permite integrar sistemas externos à plataforma INC Cloud da Intelbras. Com ela você consulta, de forma programática, os dados das redes gerenciadas pela nuvem: sites, dispositivos (switches, pontos de acesso e controladoras), clientes conectados, estatísticas de uso, relatórios, alarmes e logs de operação.

## O que dá para fazer

| Grupo            | Para que serve                                                                                                                              |
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| **Usuários**     | Listar os sites que a conta gerencia, a árvore de regiões e o histórico de autenticação no portal cativo.                                   |
| **Dispositivos** | Listar dispositivos, consultar APs, rádios, SSIDs, clientes conectados, tráfego, GPS e topologia de rede, além de reiniciar um dispositivo. |
| **Estatísticas** | Obter contagem de clientes, picos, tempo de permanência, tráfego, uso por SSID e por fabricante.                                            |
| **Relatórios**   | Obter relatórios diários, semanais e mensais e o resumo de um relatório.                                                                    |
| **Alarmes**      | Listar os tipos de alarme configuráveis e o histórico de alarmes disparados.                                                                |
| **Logs**         | Consultar o log de operações feitas pelos usuários na plataforma.                                                                           |

## URL base

```
https://inccloud-api.intelbras.com.br
```

## Próximos passos

1. Veja como se [autenticar](/api-inc-cloud/autenticacao.md).
2. Entenda as [convenções](/api-inc-cloud/convencoes.md) usadas em todas as chamadas.
3. Faça sua primeira integração seguindo os [primeiros passos](/api-inc-cloud/primeiros-passos.md).
4. Consulte a referência completa de cada endpoint no menu ao lado.


---

# 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://portal-integracao.intelbras.com.br/api-inc-cloud/introducao.md?ask=<question>&goal=<user_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.