Pular para o conteúdo

API e MCP

A Aurora expõe o site e o hub por uma API documentada em OpenAPI e por um servidor MCP, que conecta assistentes de IA (Claude, ChatGPT e outros) ao blog, ao formulário de contato e, com token, à operação do hub.

Servidor MCP

Endereço: https://auroraliderancacontabilidade.com/mcp, em HTTP (Streamable HTTP), sem sessão e com respostas em JSON. Sem token, só as ferramentas públicas aparecem. Com o token pessoal criado no hub (Meu perfil → Tokens do MCP), aparecem as do seu acesso.

{
  "mcpServers": {
    "aurora": {
      "type": "http",
      "url": "https://auroraliderancacontabilidade.com/mcp",
      "headers": {
        "Authorization": "Bearer <seu token do hub>"
      }
    }
  }
}
Ferramentas do MCP e quem pode usá-las
FerramentaO que fazAcesso
saudeEstado da aplicação e dos serviços (banco, cache, armazenamento), como em /api/health.Pública (sem token)
blog_listarArtigos publicados no blog, do mais recente ao mais antigo, com busca sem acento (q), filtro por categoria (público: empresas, mei, pessoa-fisica, produtor-rural, gestao-e-patrimonio, parceiros), por servico (o id de um serviço do catálogo, como irpf) e por quem assina (autor).Pública (sem token)
blog_obterUm artigo publicado, pela categoria e pelo endereço (slug), com assinatura e ressalva.Pública (sem token)
acervo_listarAtivos publicados com versão e impressão digital do conteúdo, paginados — a leitura de integração do acervo.Pública (sem token)
acervo_obterUm ativo publicado pelo identificador, com versão e impressão digital.Pública (sem token)
medicao_configuracaoO ID público do Google Analytics 4 do site, ou null quando não configurado.Pública (sem token)
contato_enviarRegistra um pedido de atendimento no funil do escritório, como o formulário do site.Pública (sem token)
artigos_listarTodos os artigos do hub com estado, categoria, tags, marca de taxonomia legada, autoria e destaque.Equipe do hub (token)
artigo_obterUm artigo com a versão atual, as ações permitidas para quem pede e a trilha.Equipe do hub (token)
artigo_criarCria um rascunho vazio em nome de quem pede.Equipe do hub (token)
artigo_salvarSalva uma versão nova do conteúdo (categoria, tags, slug, título, subtítulo, pergunta respondida, resposta direta, corpo e termos).Equipe do hub (token)
artigo_transicionarEnvia para revisão (submeter), conclui e assina de uma vez (concluir_e_assinar, só administrador), aprova, publica, tira do ar (despublicar) ou destaca no blog — só as ações que o artigo permite a quem pede.Equipe do hub (token)
publicacoes_agenda_listarPublicações agendadas (da mais próxima) e o histórico de 90 dias: publicadas, canceladas e falhas, com o motivo.Equipe do hub (token)
publicacao_agendarMarca data e hora (ISO 8601 com fuso) para publicar um artigo APROVADO; reagendar substitui o anterior.Administrador (token)
agendamento_cancelarO artigo continua aprovado, sem horário.Administrador (token)
agendamento_publicar_agoraPublica já, sem esperar o horário marcado.Administrador (token)
cadencia_lerDias da semana (0 = domingo) e horário de Brasília, com o próximo horário livre sugerido.Equipe do hub (token)
cadencia_salvarGrava uma versão nova da cadência (dias e horário).Administrador (token)
artigo_devolverO revisor devolve o artigo em revisão com o motivo, que entra na trilha.Equipe do hub (token)
artigos_importar_redigidosLeva ao hub, como rascunhos, os artigos redigidos no código do site que ainda não existem lá (pelo endereço).Administrador (token)
pessoas_listarPessoas, papéis, situação e assinatura (cargo, credencial, link).Administrador (token)
pessoa_criarCria a conta com senha provisória, devolvida uma vez nesta resposta.Administrador (token)
pessoa_alterarNome, papel, situação (ativa) e assinatura de uma pessoa.Administrador (token)
pessoa_redefinir_senhaGera senha provisória (devolvida uma vez) e encerra as sessões da pessoa.Administrador (token)
ressalva_lerO texto que aparece no fim de cada artigo publicado.Administrador (token)
ressalva_definirGrava uma versão nova da ressalva (a anterior fica no histórico).Administrador (token)
contatos_listarPedidos do formulário do site no funil (Aguardando → Cancelado).Equipe do hub (token)
contato_obterDados do pedido e o histórico de etapas e anotações.Equipe do hub (token)
contato_moverAguardando, Contato, Proposta, Contrato, Concluído ou Cancelado.Equipe do hub (token)
contato_anotarAcrescenta uma anotação ao histórico do contato.Equipe do hub (token)
contato_excluirApaga o contato e o histórico (pedido do titular, LGPD art.Equipe do hub (token)
email_lerServiço de envio (SMTP, Brevo ou Resend) e estado — nunca o segredo.Administrador (token)
email_salvarGrava a configuração em configuracao (provedor smtp, brevo ou resend; o segredo, se enviado, é cifrado).Administrador (token)
email_removerApaga a configuração e o segredo.Administrador (token)
email_testarEnvia um e-mail de teste pelo serviço configurado.Administrador (token)
ia_listarOpenAI, Anthropic e Gemini: se há chave, o modelo padrão, os modelos vistos e o último teste — nunca a chave.Administrador (token)
ia_salvarGrava o modelo padrão e, se enviada, a chave da API (cifrada).Administrador (token)
ia_removerApaga a chave e o modelo padrão do provedor.Administrador (token)
ia_testarPede ao provedor a lista de modelos (não gera texto nem gasta crédito) e grava o resultado.Administrador (token)
auditoria_listarQuem fez o quê, como e quando: escritas no hub, no site e no MCP, acessos e eventos do sistema.Administrador (token)
monitoramento_lerQuais peças de monitoramento estão ligadas (Sentry, GA4, Cloudflare, cópia do backup).Administrador (token)
perfil_lerNome, e-mail, acesso e se há foto, da pessoa dona do token.Equipe do hub (token)
perfil_atualizar_nomeTroca o nome da pessoa dona do token.Equipe do hub (token)
perfil_remover_fotoApaga a foto da pessoa dona do token; o hub volta às iniciais.Equipe do hub (token)
notificacoes_listarNotificações da pessoa dona do token, da mais nova à mais antiga, com filtro (todas ou não lidas) e por tipo, e o total de não lidas.Equipe do hub (token)
notificacoes_marcar_lidasSem ids, marca todas as não lidas; com ids, só essas.Equipe do hub (token)
notificacao_marcarMarca uma notificação como lida ou de volta como não lida.Equipe do hub (token)
notificacoes_preferencias_lerPor tipo: no sino e por e-mail; e se o e-mail está disponível.Equipe do hub (token)
notificacoes_preferencias_salvarGrava, por tipo, se o aviso aparece no sino e se vai por e-mail.Equipe do hub (token)
notificacoes_padrao_lerO que vale, por tipo, para quem ainda não mudou as próprias preferências.Administrador (token)
notificacoes_padrao_salvarGrava uma versão nova do padrão por tipo (no sino, por e-mail).Administrador (token)
painel_lerCloudflare, Google Analytics, Sentry e os números do hub, cada fonte com o próprio estado.Equipe do hub (token)

API do site

Pública, sem autenticação. Contrato completo: /api/v1/openapi.json (versão 2.0.0).

acervo · 2 operações · Leitura pública do acervo editorial publicado.
OperaçãoO que faz
GET /api/v1/acervoLista as peças publicadas do acervo editorial.
GET /api/v1/acervo/{identificador}Devolve uma peça publicada do acervo.
plataforma · 1 operação · Exame de saúde da instância — contrato da plataforma, sem versão.
OperaçãoO que faz
GET /api/healthEstado da instância e dos seis serviços canônicos.
medicao · 1 operação · Configuração pública de medição de audiência, lida só depois do aceite de cookies.
OperaçãoO que faz
GET /api/v1/medicaoID público do Google Analytics 4, quando configurado.
contatos · 1 operação · Pedido de atendimento enviado pelo formulário do site (rodada E).
OperaçãoO que faz
POST /api/v1/contatosRecebe um pedido de atendimento do formulário do site.
blog · 2 operações · O blog exatamente como o site mostra (AURORA-ADR-012).
OperaçãoO que faz
GET /api/v1/blogArtigos publicados no blog, como o site mostra.
GET /api/v1/blog/{categoria}/{slug}Um artigo publicado, pelo endereço que ele tem no site.
contrato · 1 operação · Este contrato, servido pela própria aplicação.
OperaçãoO que faz
GET /api/v1/openapi.jsonEste contrato, em JSON (AURORA-SPEC-007 C-03, AURORA-ADR-012).
mcp · 3 operações · Servidor MCP no mesmo processo (AURORA-ADR-012).
OperaçãoO que faz
GET /mcpNão há fluxo de eventos nem sessão (sem estado).
POST /mcpServidor MCP (Streamable HTTP, sem estado, resposta em JSON).
DELETE /mcpNão há sessão a encerrar (sem estado).

API do hub

É a mesma API que a interface do hub usa: exige sessão de quem está logado, e cada acesso (operador, administrador) vê o que lhe cabe. Para automação, use o MCP com token. Contrato completo: https://app.auroraliderancacontabilidade.com/api/v1/openapi.json (versão 2.0.0).

sessao · 6 operações
OperaçãoO que faz
GET https://app.auroraliderancacontabilidade.com/api/v1/sessaoQuem está logado.
POST https://app.auroraliderancacontabilidade.com/api/v1/sessaoEntra com e-mail e senha.
DELETE https://app.auroraliderancacontabilidade.com/api/v1/sessaoEncerra a sessão.
POST https://app.auroraliderancacontabilidade.com/api/v1/sessao/senhaTroca a própria senha (inclusive a provisória do primeiro acesso).
POST https://app.auroraliderancacontabilidade.com/api/v1/sessao/recuperacaoPede o link de redefinição de senha por e-mail (rodada J).
POST https://app.auroraliderancacontabilidade.com/api/v1/sessao/recuperacao/confirmarCria a senha nova com o código do link; encerra as sessões abertas da pessoa.
artigos · 6 operações
OperaçãoO que faz
GET https://app.auroraliderancacontabilidade.com/api/v1/artigoslistar_artigos
POST https://app.auroraliderancacontabilidade.com/api/v1/artigosCria um rascunho vazio.
POST https://app.auroraliderancacontabilidade.com/api/v1/artigos/importar-redigidosLeva ao hub, como rascunhos, os artigos redigidos no código (só administrador).
GET https://app.auroraliderancacontabilidade.com/api/v1/artigos/{id}obter_artigo
PUT https://app.auroraliderancacontabilidade.com/api/v1/artigos/{id}/conteudoSalva uma versão nova do rascunho (igual à anterior não cria versão).
POST https://app.auroraliderancacontabilidade.com/api/v1/artigos/{id}/devolverRevisor devolve à autora, com o motivo na trilha.
pessoas · 4 operações
OperaçãoO que faz
GET https://app.auroraliderancacontabilidade.com/api/v1/pessoasSó administrador.
POST https://app.auroraliderancacontabilidade.com/api/v1/pessoasCria a conta com senha provisória, mostrada uma vez nesta resposta.
PATCH https://app.auroraliderancacontabilidade.com/api/v1/pessoas/{id}alterar_pessoa
POST https://app.auroraliderancacontabilidade.com/api/v1/pessoas/{id}/redefinir-senhaNova senha provisória; as sessões da pessoa são encerradas.
configuracao · 4 operações
OperaçãoO que faz
GET https://app.auroraliderancacontabilidade.com/api/v1/configuracaoler_configuracao
PUT https://app.auroraliderancacontabilidade.com/api/v1/configuracao/ressalvaGrava uma versão nova da ressalva (a anterior fica no histórico).
GET https://app.auroraliderancacontabilidade.com/api/v1/configuracao/notificacoesO padrão do escritório por tipo, para quem ainda não mudou as próprias preferências.
PUT https://app.auroraliderancacontabilidade.com/api/v1/configuracao/notificacoesGrava uma versão nova do padrão (a anterior fica no histórico).
contatos · 5 operações
OperaçãoO que faz
GET https://app.auroraliderancacontabilidade.com/api/v1/contatosFunil de contatos do site.
GET https://app.auroraliderancacontabilidade.com/api/v1/contatos/{id}obter_contato
DELETE https://app.auroraliderancacontabilidade.com/api/v1/contatos/{id}Apaga o contato e o histórico (pedido do titular, LGPD art.
POST https://app.auroraliderancacontabilidade.com/api/v1/contatos/{id}/etapamover_contato
POST https://app.auroraliderancacontabilidade.com/api/v1/contatos/{id}/anotacoesanotar_contato
integracoes · 9 operações
OperaçãoO que faz
GET https://app.auroraliderancacontabilidade.com/api/v1/integracoes/emailEstado do SMTP do cliente.
PUT https://app.auroraliderancacontabilidade.com/api/v1/integracoes/emailGrava a configuração (SMTP, Brevo ou Resend); o segredo, quando enviado, é cifrado (AES-256-GCM).
DELETE https://app.auroraliderancacontabilidade.com/api/v1/integracoes/emailremover_integracao_de_email
POST https://app.auroraliderancacontabilidade.com/api/v1/integracoes/email/testetestar_integracao_de_email
GET https://app.auroraliderancacontabilidade.com/api/v1/integracoes/iaChaves de IA do escritório (rodada P) — o estado de cada provedor, nunca a chave.
PUT https://app.auroraliderancacontabilidade.com/api/v1/integracoes/ia/{provedor}Grava o modelo padrão e, se enviada, a chave da API (cifrada).
DELETE https://app.auroraliderancacontabilidade.com/api/v1/integracoes/ia/{provedor}remover_chave_de_ia
POST https://app.auroraliderancacontabilidade.com/api/v1/integracoes/ia/{provedor}/testePede a lista de modelos ao provedor (não gera texto nem gasta crédito); o resultado fica em ultimoTeste.
GET https://app.auroraliderancacontabilidade.com/api/v1/integracoes/monitoramentoPeças de monitoramento ligadas por variável do servidor.
painel · 1 operação
OperaçãoO que faz
GET https://app.auroraliderancacontabilidade.com/api/v1/painelCloudflare, Google Analytics, Sentry e números do hub (shared/painel.ts).
tokens · 3 operações · Tokens pessoais do MCP (AURORA-ADR-012).
OperaçãoO que faz
GET https://app.auroraliderancacontabilidade.com/api/v1/tokensOs tokens ativos de quem pede (nunca o token inteiro).
POST https://app.auroraliderancacontabilidade.com/api/v1/tokensCria um token pessoal do MCP.
DELETE https://app.auroraliderancacontabilidade.com/api/v1/tokens/{id}Revoga um token de quem pede.
perfil · 5 operações · Meu perfil (rodada N, AURORA-ADR-013).
OperaçãoO que faz
GET https://app.auroraliderancacontabilidade.com/api/v1/contaA conta de quem está logado (nome, e-mail, acesso e versão da foto).
PUT https://app.auroraliderancacontabilidade.com/api/v1/conta/perfilTroca o próprio nome.
PUT https://app.auroraliderancacontabilidade.com/api/v1/conta/fotoGrava a própria foto (PNG, JPEG ou WebP em data URL, até 256 KB; o hub reduz para 256 px antes de enviar).
DELETE https://app.auroraliderancacontabilidade.com/api/v1/conta/fotoRemove a própria foto; o hub volta a mostrar as iniciais.
GET https://app.auroraliderancacontabilidade.com/api/v1/pessoas/{id}/fotoA foto de uma pessoa do hub, para avatares (só com sessão).
notificacoes · 5 operações · Notificações de quem está logado (rodada O, AURORA-ADR-013).
OperaçãoO que faz
GET https://app.auroraliderancacontabilidade.com/api/v1/notificacoesAs próprias notificações, da mais nova à mais antiga, com o total de não lidas.
POST https://app.auroraliderancacontabilidade.com/api/v1/notificacoes/lidasMarca como lidas todas as não lidas, ou só as dos ids enviados.
GET https://app.auroraliderancacontabilidade.com/api/v1/notificacoes/preferenciasPor tipo, no sino e por e-mail; e se o e-mail está disponível.
PUT https://app.auroraliderancacontabilidade.com/api/v1/notificacoes/preferenciasGrava as preferências; tipos que o acesso não recebe são ignorados.
PATCH https://app.auroraliderancacontabilidade.com/api/v1/notificacoes/{id}Marca uma notificação como lida ou de volta como não lida.
publicacoes · 6 operações · Agenda e cadência de publicação do blog (rodada S).
OperaçãoO que faz
GET https://app.auroraliderancacontabilidade.com/api/v1/publicacoes/agendaAgendadas (da mais próxima) e o histórico de 90 dias.
POST https://app.auroraliderancacontabilidade.com/api/v1/publicacoes/agendaAgenda (ou reagenda) a publicação de um artigo aprovado.
DELETE https://app.auroraliderancacontabilidade.com/api/v1/publicacoes/agenda/{id}Cancela a publicação agendada; o artigo continua aprovado.
POST https://app.auroraliderancacontabilidade.com/api/v1/publicacoes/agenda/{id}/publicar-agoraPublica já o artigo agendado.
GET https://app.auroraliderancacontabilidade.com/api/v1/publicacoes/cadenciaDias e horário (Brasília) e o próximo horário livre sugerido.
PUT https://app.auroraliderancacontabilidade.com/api/v1/publicacoes/cadenciaGrava uma versão nova da cadência.
auditoria · 2 operações · Quem fez o quê, como e quando (rodada Q, AURORA-ADR-013 D-6).
OperaçãoO que faz
GET https://app.auroraliderancacontabilidade.com/api/v1/auditoriaRegistros de auditoria, do mais novo ao mais antigo.
GET https://app.auroraliderancacontabilidade.com/api/v1/auditoria/exportacaoOs mesmos filtros, até 10 mil registros, em CSV (;, UTF-8 com BOM).
contrato · 1 operação
OperaçãoO que faz
GET https://app.auroraliderancacontabilidade.com/api/v1/openapi.jsonEste contrato, em JSON (AURORA-ADR-012).
outros · 6 operações
OperaçãoO que faz
POST https://app.auroraliderancacontabilidade.com/api/v1/artigos/{id}/submeter
POST https://app.auroraliderancacontabilidade.com/api/v1/artigos/{id}/concluir-e-assinar
POST https://app.auroraliderancacontabilidade.com/api/v1/artigos/{id}/aprovar
POST https://app.auroraliderancacontabilidade.com/api/v1/artigos/{id}/publicar
POST https://app.auroraliderancacontabilidade.com/api/v1/artigos/{id}/despublicar
POST https://app.auroraliderancacontabilidade.com/api/v1/artigos/{id}/destacar

Cookies e privacidade

Usamos o essencial para o site funcionar. Com a sua permissão, usamos também o Google Analytics para entender, de forma agregada, como o site é usado. Você pode mudar a escolha quando quiser em “Alterar cookies”, no rodapé.

Ler a política de cookies