> ## Documentation Index
> Fetch the complete documentation index at: https://developers.useqx.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introdução

> O que a API do QX faz e como começar.

A API do QX dá ao sistema de uma organização acesso aos dados dessa organização. Com a API, o seu sistema:

* cria e lê os contatos;
* cria e lê as coletas;
* envia os documentos, lê os campos que a leitura extrai e grava as respostas dos campos;
* lista os pacotes e os requisitos de cada pacote.

## O endereço

Todas as chamadas usam este endereço base:

```text theme={null}
https://app.useqx.com/api/v1
```

A API devolve JSON. Ela recebe JSON, e o envio de arquivo usa `multipart/form-data`.

## Os primeiros passos

1. Peça ao QX uma chave de API para a organização. Veja [Autenticação](/authentication).
2. Chame `GET /packs` com a chave no cabeçalho `Authorization`.
3. Leia os pacotes no campo `data` da resposta.

```bash theme={null}
curl https://app.useqx.com/api/v1/packs \
  -H "Authorization: Bearer qx_sua_chave"
```

Depois, siga o [Guia rápido](/quickstart). Ele cria um contato e uma coleta, envia uma fatura e lê os campos da fatura.

## As regras de toda chamada

* Chame a API a partir do servidor do seu sistema. A API não envia cabeçalhos CORS, e por isso o navegador bloqueia a resposta.
* A API responde cada erro no formato da RFC 9457. Veja [Erros](/errors).
* Uma lista devolve uma página por vez. Veja [Paginação](/pagination).
* Os nomes de campo, os valores de enum e os códigos de erro ficam em inglês. A explicação de cada erro fica em português.