Skip to content

Hub API - Aprova

O Hub API é uma plataforma de abstração de APIs projetada para padronizar e simplificar a integração de sistemas de parceiros terceiros com o Aprova. O principal objetivo é criar um ponto de entrada único e seguro para as funcionalidades do Aprova. Utilizamos um sistema de autenticação robusto para garantir que o uso dos nossos serviços por terceiros seja seguro, controlado e intuitivo. Isso facilita o trabalho de desenvolvedores externos e reduz a complexidade da integração.

Como Obter sua Chave API

Para começar a usar o Hub API, siga os passos abaixo para habilitar a funcionalidade e gerar suas chaves de acesso:

Passo 1: Ative a Permissão de Administrador

  • Navegue até: Outros > Administração Geral > Permissões > Todas as Permissões
  • Ative a permissão hubapi:admin
  • Vincule essa permissão a um grupo de usuários administradores
  • Saia do sistema e entre novamente

Passo 2: Acesse o Gerenciador de Chaves

  • Após ativar a permissão, um novo menu aparecerá
  • Navegue até: Outros > Administração Geral > Gerenciar Ambiente > Chaves API - Hub API

Passo 3: Crie sua Chave API

  • Clique em Criar Chave API
  • Defina um nome único para identificar a chave
  • Copie e salve a chave exibida imediatamente

IMPORTANTE: A chave API será exibida por completo apenas uma vez. Após sair da tela, por motivos de segurança, a chave completa não será mostrada novamente. Certifique-se de armazená-la em um local seguro.

Download OpenAPI description
aprovahubapi.json
aprovahubapi.yaml
Overview
Aprova
suporte@aprova.com.br
Languages
Servers
https://api.producao.aprova.com.br

Process

Operações relacionadas à consulta de processos

Operations

Dispatch

Operações relacionadas à criação e edição de despachos

Operations

Type

Operações relacionadas a assuntos (types)

Operations

Template

Operações relacionadas a templates de processos

Operations

Retorna o HTML de um template pelo nome

Request

Retorna o conteúdo HTML de um template de processo a partir do seu nome. O nome do template segue o padrão {Cidade}/{NomeArquivo}.html (ex: MogidascruzesSP/Alvara_Aprovacao_Execucao_Projetos.html).

Seleção da versão:

  • Usa a versão ativa (actual_version) quando existir e tiver HTML válido
  • Caso contrário, utiliza a última versão (maior índice) com HTML válido
  • Permite fallback quando actual_version está ausente ou aponta para versão sem conteúdo

Validação de HTML:

  • Retorna 404 quando o HTML está vazio, nulo ou contém apenas espaços em branco

Possíveis erros 404:

  • Template não encontrado no banco
  • Template sem versões
  • Template sem HTML válido (vazio ou inexistente) em nenhuma versão
Security
InternalAuth
Query
namestringrequired

Nome do template no formato {Cidade}/{NomeArquivo}.html.

Example: name=MogidascruzesSP/Alvara_Aprovacao_Execucao_Projetos.html
curl -i -X GET \
  'https://api.producao.aprova.com.br/hub-api/template?name=MogidascruzesSP%2FAlvara_Aprovacao_Execucao_Projetos.html' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Template encontrado com sucesso

Bodyapplication/json
namestring

Nome do arquivo de template

Example: "MogidascruzesSP/Alvara_Aprovacao_Execucao_Projetos.html"
htmlstring

Conteúdo HTML completo da versão do template (nunca vazio)

Example: "<!DOCTYPE html><html><head><title>Alvará de Aprovação</title></head><body>...</body></html>"
created_at_isostring or null

Data de criação da versão retornada (ISO 8601)

Example: "2025-08-15T14:30:00.000Z"
fromstring or null

Autor ou origem da versão retornada

Example: "admin@cidade.gov.br"
Response
application/json
{
  "name": "MogidascruzesSP/Alvara_Aprovacao_Execucao_Projetos.html",
  "html": "<!DOCTYPE html><html><head><title>Alvará de Aprovação</title></head><body>...</body></html>",
  "created_at_iso": "2025-08-15T14:30:00.000Z",
  "from": "admin@cidade.gov.br"
}

Users

Operações relacionadas à consulta de usuários

Operations