> For the complete documentation index, see [llms.txt](https://docs.giro.tech/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.giro.tech/desenvolvedores/api-gtfgts/guias.md).

# Guias

Documentação conceitual e guias de integração da **API GTFgts** — a API de operações FGTS junto à Caixa para originators. Comece pela autenticação, entenda o modelo assíncrono e use as páginas de referência para cada operação.

| Guia                                                                                                                | Descrição                                                                                                           |
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| [Ambientes e Autenticação](https://docs.giro.tech/desenvolvedores/api-gtfgts/guias/ambientes-e-autenticacao.md)     | URLs de homologação/produção, JWT do originator, headers obrigatórios e códigos de resposta.                        |
| [Fluxo assíncrono e polling](https://docs.giro.tech/desenvolvedores/api-gtfgts/guias/fluxo-assincrono-e-polling.md) | O ciclo `submeter → 202 → webhook/polling`, o ciclo de vida do `status` e a resposta em cache da consulta de saldo. |
| [Operações FGTS](https://docs.giro.tech/desenvolvedores/api-gtfgts/guias/operacoes-fgts.md)                         | Catálogo das 7 operações FGTS: o que cada uma faz, endpoint, prioridade e o formato do `result`.                    |
| [Prioridades e rate limit](https://docs.giro.tech/desenvolvedores/api-gtfgts/guias/prioridades-e-rate-limit.md)     | Prioridades `NORMAL` vs `DEFERRED` e tratamento do `429`.                                                           |
| [Erros da API](https://docs.giro.tech/desenvolvedores/api-gtfgts/guias/erros.md)                                    | Erros de borda (RFC 7807 / `ProblemDetail`) e o erro de operação (`OperationError`).                                |
| [Idempotência](https://docs.giro.tech/desenvolvedores/api-gtfgts/guias/idempotencia.md)                             | O header `Idempotency-Key` na submissão e o `requestId` como chave de deduplicação.                                 |
| [Sandbox de Testes (Mock da Caixa)](https://docs.giro.tech/desenvolvedores/api-gtfgts/guias/sandbox-mock-caixa.md)  | Controle das respostas da Caixa em homologação: cenários por CPF/default, presets e reset via `/api/v1/mock/caixa`. |
| [Glossário](https://docs.giro.tech/desenvolvedores/api-gtfgts/guias/glossario.md)                                   | Principais termos do domínio FGTS e da integração.                                                                  |

{% embed url="<https://giro.tech/central-de-atendimento/>" %}
