> For the complete documentation index, see [llms.txt](https://docs.caf.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.caf.io/caf-api/caf-api-pt-br/readme.md).
# Visão geral
Bem-vindo à documentação da API! Nesta página, você encontrará tudo o que precisa saber para melhorar a segurança e a qualidade dos seus aplicativos usando nossa API.
### Integração
A API da CAF segue o [REST ](https://en.wikipedia.org/wiki/Representational_state_transfer)padrão. Portanto, nossa API possui URLs previsíveis orientadas a recursos que aceitam e retornam dados em formato JSON, além de usar códigos HTTP padrão na resposta.
{% hint style="warning" %}
**Aviso importante sobre autenticação e integrações**
Todas as integrações com as APIs da CAF devem ser implementadas exclusivamente via backend/server-side. Integrações no lado do cliente ou baseadas em frontend podem ser bloqueadas e aumentam significativamente o risco de exposição da chave de autenticação.
A Caf monitora continuamente o uso e a exposição das chaves de autenticação. Qualquer chave identificada como exposta, comprometida ou usada em implementações não conformes será revogada imediatamente, o que pode resultar na interrupção da operação associada, sem aviso prévio.
É responsabilidade do integrador garantir conformidade com os padrões de autenticação recomendados e as melhores práticas de segurança descritas nesta documentação.
{% endhint %}
### Respostas
Usamos códigos de resposta convencionais para indicar sucesso ou falha em uma solicitação. Em resumo, códigos na `2xx` faixa representam sucesso. Códigos na `4xx` faixa indicam tipos de erro de validação com as informações fornecidas ou falhas mapeadas. Por fim, códigos na `5xx` faixa indicam um erro nos servidores ou alguma outra falha imprevista.
Além disso, todas as respostas têm um identificador para a solicitação, o `requestId` campo. Esse campo é útil para encontrarmos a solicitação exata em caso de investigação.
---
# 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.caf.io/caf-api/caf-api-pt-br/readme.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.