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

Consulta um processo por np e codvalid

Request

Este endpoint permite consultar um processo específico utilizando o número do processo (nP) e o código validador (codValid).

Security
InternalAuth
Bodyapplication/jsonrequired
nPstringrequired

Número do processo

Example: "337-25-pro-alv"
codValidstringrequired

Código validador

Example: "ckusqxyx"
curl -i -X POST \
  https://api.producao.aprova.com.br/hub-api/process/get-by-np \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "nP": "337-25-pro-alv",
    "codValid": "ckusqxyx"
  }'

Responses

Processo encontrado com sucesso

Bodyapplication/json
idstring

Identificador único do processo

Example: "507f1f77bcf86cd799439011"
nPstring

Número do processo

Example: "123-25-PRO-EXE"
cod_validstring

Código validador do processo

Example: "abc12xyz"
fromobject

Informações do criador do processo

configMetadataobject

Metadados da configuração do processo

lastVersionobject

Última versão do processo com todos os dados e campos preenchidos

createdAtstring

Data de criação do processo

Example: "15/10/2025 09:30:00"
timelineArray of objects

Linha do tempo com todos os eventos do processo

Example: [{"from":{"userId":"auth0|123456789abcdef012345678","name":"João da Silva Santos","asSector":null},"class":"user","type":"evento","data":{"action":"Processo criado"},"date":"15/10/2025 09:30:00","created_at_iso":"2025-10-15T12:30:00.000Z"},{"from":{"userId":"Desconhecido","name":"Desconhecido/Evento Automático"},"to":{"name":"Setor de Urbanismo","userId":"setor_urbanismo"},"class":"prefeituraEncaminha","type":"evento","data":{"action":"Processo encaminhado com acesso total para Setor de Urbanismo"},"date":"15/10/2025 09:30:15","created_at_iso":"2025-10-15T12:30:15.000Z"},{"class":"message","type":"evento","data":{"action":"Documento de Aprovação emitido"},"from":{"userId":"auth0|987654321fedcba987654321","name":"Maria Oliveira Costa"},"date":"16/10/2025 14:20:00","created_at_iso":"2025-10-16T17:20:00.000Z"}]
Response
application/json
{
  "id": "507f1f77bcf86cd799439011",
  "nP": "123-25-PRO-EXE",
  "cod_valid": "abc12xyz",
  "from": {
    "userID": "auth0|123456789abcdef012345678"
  },
  "configMetadata": {
    "title": "Alvará de Construção",
    "id": "507f191e810c19729de860ea"
  },
  "lastVersion": {
    "from": { … },
    "proprietario": [],
    "destinatario": [ … ],
    "refinamento": { … },
    "cpf_cnpj": "123.456.789-00",
    "created_at_iso": "2025-10-15T14:30:00.000Z",
    "created_at": "15/10/2025 11:30:00",
    "hasSensitiveField": true
  },
  "createdAt": "15/10/2025 09:30:00",
  "timeline": [
    { … },
    { … },
    { … }
  ]
}

Cria um processo sem validação de regras de formulário

Request

Cria um processo sem validação de regras de formulário (salva a version da forma que recebeu). Este endpoint permite criar processos diretamente sem passar pelas validações padrão do sistema.

Security
InternalAuth
Bodyapplication/jsonrequired
versionobjectrequired

Dados da versão do processo (será salvo exatamente como recebido)

Example: {"from":{"type":"user","label":"João da Silva","value":"auth0|123456789abcdef012345678"},"proprietario":[],"destinatario":[],"refinamento":{}}
version.​property name*anyadditional property
city_idnumberrequired

ID da cidade

Example: 123
config_metadataobjectrequired

Metadados de configuração do processo

Example: {"id":"507f191e810c19729de860ea","title":"Alvará de Construção"}
config_metadata.​property name*anyadditional property
configArray of objectsrequired

Configuração do formulário

Example: []
config[].​property name*anyadditional property
stepobject

Configuração de etapas (opcional)

destinationobject

Configuração de destino (opcional)

bondobject

Configuração de vínculo (opcional)

tenancestring

Valor de tenance (opcional)

Example: ""
_idstring

ID do rascunho (opcional)

Example: "507f1f77bcf86cd799439012"
resetCountEveryYearboolean

Flag para resetar contagem a cada ano (opcional)

Example: false
fromobject

Informações do usuário remetente (opcional)

form_tramitesArray of objects

Configuração de formulários de trâmites (opcional)

s3_tokenstring

Token S3 para upload de arquivos (opcional)

Example: ""
statusstring

Status do processo

Example: ""
analisesArray of objects

Análises do processo (opcional)

anotacoesAnalistaArray of objects

Anotações do analista (opcional)

observacoesArray of objects

Observações do processo (opcional)

tramitesArray of objects

Trâmites do processo (opcional)

notesArray of objects

Notas do processo (opcional)

tagsArray of objects

Tags do processo (opcional)

curl -i -X POST \
  https://api.producao.aprova.com.br/hub-api/process/create \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "version": {
      "from": {
        "type": "user",
        "label": "João da Silva",
        "value": "auth0|123456789abcdef012345678"
      },
      "proprietario": [],
      "destinatario": [],
      "refinamento": {}
    },
    "city_id": 123,
    "config_metadata": {
      "id": "507f191e810c19729de860ea",
      "title": "Alvará de Construção"
    },
    "config": [],
    "step": {},
    "destination": {},
    "bond": {},
    "tenance": "",
    "_id": "507f1f77bcf86cd799439012",
    "resetCountEveryYear": false,
    "from": {
      "email": "usuario@exemplo.com",
      "userID": "auth0|123456789abcdef012345678",
      "alias": {}
    },
    "form_tramites": [
      {}
    ],
    "s3_token": "",
    "status": "",
    "analises": [
      {}
    ],
    "anotacoesAnalista": [
      {}
    ],
    "observacoes": [
      {}
    ],
    "tramites": [
      {}
    ],
    "notes": [
      {}
    ],
    "tags": [
      {}
    ]
  }'

Responses

Processo criado com sucesso

Bodyapplication/json
idstring

Identificador único do processo criado

Example: "507f1f77bcf86cd799439011"
nPstring

Número do processo gerado

Example: "123-25-PRO-EXE"
cod_validstring

Código validador do processo

Example: "abc12xyz"
fromobject

Informações do criador do processo

config_metadataobject

Metadados da configuração do processo

last_versionobject

Última versão do processo criado

created_atstring

Data de criação do processo

Example: "15/10/2025 09:30:00"
city_idnumber

ID da cidade do processo

Example: 123
Response
application/json
{
  "id": "507f1f77bcf86cd799439011",
  "nP": "123-25-PRO-EXE",
  "cod_valid": "abc12xyz",
  "from": {
    "userID": "auth0|123456789abcdef012345678",
    "email": "usuario@exemplo.com"
  },
  "config_metadata": {
    "id": "507f191e810c19729de860ea",
    "title": "Alvará de Construção"
  },
  "last_version": {},
  "created_at": "15/10/2025 09:30:00",
  "city_id": 123
}

Retorna o JSON cru de um processo ou formulário

Request

Retorna o JSON completo (sem transformações) de um processo ou formulário diretamente do MongoDB, a partir do ObjectId do documento.

Controle de acesso por nível de permissão da API Key:

  • tenant — retorna o documento somente se o city_id do documento corresponder ao município vinculado à API Key. Caso contrário, retorna 403.
  • support — acesso irrestrito, retorna qualquer documento independentemente do município.
Security
InternalAuth
Query
idstring^[a-fA-F0-9]{24}$required

ObjectId do documento (24 caracteres hexadecimais)

Example: id=507f1f77bcf86cd799439011
typestringrequired

Tipo do documento

Enum"process""form"
Example: type=process
curl -i -X GET \
  'https://api.producao.aprova.com.br/hub-api/document/json?id=507f1f77bcf86cd799439011&type=process' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

JSON do documento retornado com sucesso

Bodyapplication/json
property name*anyadditional property
Response
application/json
{
  "_id": "507f1f77bcf86cd799439011",
  "city_id": 123,
  "nP": "123-25-PRO-EXE"
}

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

Users

Operações relacionadas à consulta de usuários

Operations