> For the complete documentation index, see [llms.txt](https://docs.barte.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.barte.com/collections/como-utilizar/readme.md).

# Collections

Para facilitar seus testes e integrações, disponibilizamos uma collection pré-configurada com todas as rotas da Referência de API da Barte. O arquivo segue o formato Postman Collection v2.1, que os principais clientes de API importam:

* **Postman**
* **Insomnia**
* **Bruno**
* **Hoppscotch**

A collection inclui:

* Uma pasta para cada seção da Referência de API e uma requisição para cada página, com o mesmo nome
* Exemplos de `body`, headers e parâmetros retirados da documentação
* O header obrigatório `X-Token-Api` já configurado em todas as requisições
* Variáveis para o ambiente, o token e os identificadores usados nas rotas

***

### <i class="fa-floppy-disk">:floppy-disk:</i> Baixar a collection

{% file src="/files/ZQMnHmY1ICzjeQVJQmS0" %}
Barte API (Postman Collection v2.1)
{% endfile %}

#### <i class="fa-thumbtack">:thumbtack:</i> Como importar

* **Postman**: `Import`, arraste o arquivo `.json` ou selecione em `files`.
* **Insomnia**: `Import` na tela inicial do projeto e selecione o arquivo `.json`.
* **Bruno**: `Import Collection`, escolha `Postman Collection` e selecione o arquivo `.json`.
* **Hoppscotch**: `Collections`, `Import`, escolha `Postman` e selecione o arquivo `.json`.

***

### <i class="fa-screwdriver-wrench">:screwdriver-wrench:</i> Configuração

Depois de importar, preencha as variáveis da collection:

| Variável   | Valor                                                                                       |
| ---------- | ------------------------------------------------------------------------------------------- |
| `apiToken` | Sua chave de API (veja [Autenticação](https://docs.barte.com/guias/seguranca/autenticacao)) |
| `baseUrl`  | `https://api.barte.com` para produção ou `https://sandbox-api.barte.com` para sandbox       |

As demais variáveis, como `uuid`, `sellerId` e `chargeUuid`, representam os identificadores usados nas rotas. Preencha conforme os recursos da sua conta.

Nas requisições que exigem `x-idempotency-key`, o Postman gera uma chave nova a cada envio. Nos outros clientes, preencha a variável `idempotencyKey` com um valor único por operaçã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.barte.com/collections/como-utilizar/readme.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.
