# API de integração ActivePlan

Com esta API, o sistema da sua empresa envia as notas fiscais eletrônicas (NF-e) que emitiu, consulta o que pode antecipar e pede a antecipação. A assinatura do contrato e o pagamento continuam fora da API: a assinatura é feita pelos representantes da sua empresa, e o pagamento é feito pela securitizadora.

- Endereço base: `https://integracao.activeplan.com.br/v1`
- Formato: JSON em UTF-8.
- Dinheiro: centavos, em texto (`"123456"` é R$ 1.234,56).
- Datas: `AAAA-MM-DD`. Horários: ISO 8601 em UTC.
- Erros: sempre por `code`. Veja [erros](erros.md).

## O fluxo em 6 passos

1. **Receba a chave.** A securitizadora cria a chave da sua empresa e entrega o identificador (`apk_…`) e o segredo (`aps_…`). Guarde o segredo num cofre.
2. **Teste a assinatura.** Chame `GET /v1/eu`. Veja [autenticação](autenticacao.md).
3. **Envie as notas.** `POST /v1/notas` com o XML autorizado de cada NF-e. Veja [notas](notas.md).
4. **Espere a conferência.** Cada nota é conferida antes de ficar disponível. Você recebe o evento `nota.validada` ou `nota.recusada`. Veja [eventos](eventos.md).
5. **Peça a antecipação.** `GET /v1/disponiveis` mostra o que pode ser antecipado e uma simulação do valor líquido. `POST /v1/antecipacoes` cria o pedido. Veja [antecipações](antecipacoes.md).
6. **Acompanhe.** Os representantes assinam o contrato pelo link que recebem por e-mail. Você acompanha por eventos (`antecipacao.assinada`, `antecipacao.paga`) ou por `GET /v1/antecipacoes/{id}`.

## O que a API não faz

Por segurança, não existe rota para: cadastrar ou trocar conta bancária, escolher a conta de destino, trocar contatos, cadastrar o endereço de webhook, assinar contrato ou pagar. Tudo isso é feito com a securitizadora, fora da API.

## Páginas

- [Começar](comecar.md)
- [Autenticação](autenticacao.md)
- [Notas](notas.md)
- [Antecipações](antecipacoes.md)
- [Eventos e webhooks](eventos.md)
- [Validações da nota](validacoes.md)
- [Erros](erros.md)
- [Ambiente de teste](sandbox.md)
- [Para agentes de IA](ia.md)
- [Mudanças](changelog.md)
- Referência: [`openapi.json`](openapi.json) (OpenAPI 3.1)
