> For the complete documentation index, see [llms.txt](https://docs.exoclick.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.exoclick.com/api/pt/api-publica-exoclick/api-manual-interface.md).

# Interface da API

O [Interface da API](https://api.exoclick.com/v2/docs/) é uma representação da API do ExoClick concebida para detalhar os pedidos disponíveis, os respetivos parâmetros e as respostas esperadas. Pode vê-la no Painel de Administração.

Todos os pedidos da API estão listados sob o respetivo grupo.

Para aceder a pedidos restritos da API, tem de existir um Token de Sessão definido. Para definir um token, tem de ter uma conta válida com o nome de utilizador e a palavra-passe necessários ou um token de API. Clique no **Iniciar sessão** botão no canto superior direito do ecrã e introduza o seu nome de utilizador e palavra-passe ou forneça um token de API. Depois de clicar no **Iniciar sessão** botão, será feito um pedido de início de sessão à API para recuperar um token de Sessão válido. Esse token será então utilizado para validar todos os pedidos da API que pretenda fazer nessa sessão.

Para fazer um pedido à API, clique num grupo. O grupo será expandido para listar os pedidos disponíveis. Clique novamente no pedido pretendido. Um painel será expandido, detalhando as informações do pedido.

* O **Corpo da resposta**, se existir, será apresentado primeiro juntamente com a resposta **Tipo de conteúdo**.
* O **Parâmetros do pedido**, obrigatórios e/ou opcionais, são detalhados de seguida, juntamente com o pedido **Tipo de conteúdo**, se necessário.
* Esperadas **Mensagens de resposta** são então listadas.
* Para fazer o pedido, preencha os parâmetros obrigatórios. Se o corpo do pedido estiver detalhado, clicar no corpo na janela de **Modelo** irá pré-preencher a janela de parâmetros com o corpo.
* Assim que todos os parâmetros obrigatórios tiverem sido definidos, clicar no **Experimentar** botão executará o pedido.
* Abaixo do botão aparecerão quatro painéis:
  * O primeiro apresenta o **URL do pedido**.
  * O segundo detalha o **Corpo da resposta**.
  * O terceiro detalha o **Código da resposta**.
  * O quarto detalha os **Cabeçalhos da resposta**.


---

# 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.exoclick.com/api/pt/api-publica-exoclick/api-manual-interface.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.