Skip to main content
A Extat Plataforma expõe uma API REST documentada a partir do contrato sincronizado com o ambiente de stage. Esta página descreve autenticação e URL base. As operações aparecem automaticamente no grupo Operações desta aba.

​
Autenticação

Operações protegidas usam o esquema ApiKeyAuth do contrato: envie o token no cabeçalho Authorization. Na aplicação web, o cliente HTTP envia o JWT da sessão no formato Bearer <token>.
Não há fluxo documentado na plataforma para gerar um token de API em Minha Conta. Use o token de sessão obtido no login (e-mail/senha ou Google), como a própria aplicação faz.

​
URL base

O playground e os exemplos desta documentação usam o host de stage com o basePath /v1:
Em outros ambientes, use o host da API configurado para aquele ambiente. Um hostname público de produção separado não está publicado nesta documentação.

​
Formato

Requisições e respostas usam JSON. Em corpos JSON, inclua Content-Type: application/json.

​
Operações

Abra o grupo Operações nesta aba. As páginas são geradas a partir de openapi/extat-openapi.json e agrupadas por domínio em português: Autenticação, Empresa, Contas Bancárias, Demonstrativos, Plano e Assinaturas, entre outros.

​
Códigos HTTP comuns

Os códigos exatos por operação estão nas páginas geradas. Em geral:

​
Suporte

Dúvidas de produto: solução de problemas ou e-mail de suporte na barra superior.