Documentação da API Reinf

A API Reinf do Guidis Reinf cobre a operação completa da EFD-Reinf: autenticação, contexto, cadastros, envio de eventos, mensageria, webhooks, relatórios, recibos e comprovantes. A mesma integração pública é usada pelo portal, por SDKs e por agentes de IA.

A API é REST e usa autenticação por bearer token: você troca a Chave de API por um access token de curta duração. Há OpenAPI público versionado e um playground técnico para testar as chamadas.

O que esta documentação destrava

Esta documentação foi escrita para o integrador fiscal que precisa sair da credencial técnica para a operação real, sem adivinhar onde cada parte nasce. Ela cobre autenticação, primeira chamada, mensageria EFD-Reinf, envios, webhooks, relatórios e acesso ao playground técnico.

A integração também aceita planilhas oficiais e uso com agentes de IA. Claude Code, Codex e agentes próprios podem ler arquivos da apuração na máquina do usuário, como XML, PDF, Excel, CSV e documentos de apoio, antes de organizar informações do envio e operar a EFD-Reinf pela API.

Fluxo mínimo do integrador

  1. Criar a Chave de API - gere a Chave de API no portal, em Administração > Controle de Acesso > Integrações API. Ela é exibida uma única vez, na criação.
  2. Obter o token - troque a Chave de API por um access token em POST /api/integracao/token, enviando a chave no header Authorization: Bearer.
  3. Validar o contexto - comece por GET /v1/integracao/contexto e confirme que a conta está pronta.
  4. Enviar e acompanhar - cadastre dados, envie eventos e acompanhe lotes, webhooks e relatórios.
POST /api/integracao/token
Authorization: Bearer SUA_CHAVE_DE_API

Próximos passos

Playground e contrato

Use o playground para navegar pelos endpoints e testar a autenticação. O contrato público em OpenAPI serve como base para SDKs, automações e integração com ferramentas externas.

  • Playground técnico para executar chamadas reais da API
  • Especificação OpenAPI pública para download
  • Mesma autenticação por bearer token usada pelos clientes HTTP, a partir da Chave de API
  • Base útil para automações com Claude Code, Codex e agentes próprios